Jump to

• Request
• Response

Get all service requests

get

/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • MyCriticalSRsFinder :Finds critical service requests assigned to a user.
    Finder Variables:
    • AssigneeResourceId :The unique identifier of the assignee resource.
  • MySRsByStatusFinder :Finds a service requests with a specific status that are assigned to a user.
    Finder Variables:
    • AssigneeResourceId :The unique identifier of the assignee resource.
    • StatusCd :The status code of the service request.
  • MySRsFinder :Finds a service requests assigned to the user.
    Finder Variables:
    • AssigneeResourceId :The unique identifier of the assignee resource.
  • PrimaryKey :Finds a service request with the specified primary key.
    Finder Variables:
    • SrId :The unique identifier of the service request.
  • SRListMySRTeamSRsFinder :Finds service requests for the team.
    Finder Variables:
  • SRsCreatedByMeFinder :Find a service request created by a user.
    Finder Variables:
    • CreatedBy :The user who created the service request.
  • SRsListByResource :Finds a service requests by resource ID.
    Finder Variables:
    • ResourceId :The resource ID passed as parameter to the service request finder service.
  • ServiceRequestByNumber :Finds a service request by SR number.
    Finder Variables:
    • SrNumber :The service request number passed as parameter to the finder service.
  • ServiceRequestByStripeCd :Finds a service requests by stripe code.
    Finder Variables:
    • StripeCd :The stripe code passed as parameter to the service request finder service.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AffectedPartyAssignmentNumber; string; The unique assignment number of the affected party person for the service request.
  • AffectedPartyPersonName; string; The display name of the affected party person in the service request.
  • AssigneePersonName; string; The email address of the assignee.
  • AssigneeResourceId; integer; The unique identifier of the assignee resource.
  • AssigneeResourceNumber; string; The alternative key for the resource identifier of the assignee.
  • BUOrgId; integer; The unique identifier of the business unit associated to the service request.
  • CategoryCode; string; Indicates the alternate key of the category associated to the service request.
  • CategoryId; integer; The unique identifier of the service request category.
  • CategoryName; string; The name of the category associated to the service request.
  • ChannelTypeCd; string; The channel type.
  • ChannelTypeCdMeaning; string; The display value corresponding to the channel type lookup code for the service request.
  • ClosedDate; string; The date when the service request was closed, if closed.
  • ComplianceFlag; boolean; The compliance status of the milestone.
  • CreatedBy; string; The user who created the service request.
  • CreationDate; string; The date and time when the service request was created.
  • CriticalFlag; boolean; Indicates whether the service request is critical. If critical, the value is Y, else the value is N.
  • DueDate; string; The date when the milestone is due.
  • FirstTransferDate; string; The date when the service request was first transferred.
  • HeaderFlag; boolean; Indicates whether the current milestone should be saved on the service request header.
  • InternalPriorityCd; string; The internal priority of the service request.
  • InventoryItemId; integer; The unique identifier of the product associated to the service request.
  • InventoryOrgId; integer; The unique identifier of the organization of the product that's associated with the service request.
  • LanguageCd; string; The customer's preferred language for the service request.
  • LastReopenDate; string; The date and time when the service request was last reopened.
  • LastResolvedDate; string; The date and time when the service request was resolved.
  • LastTransferDate; string; Indicates the date and time of the last transfer of the service request.
  • LastTransferredBy; string; The user who last transferred the service request.
  • LastUpdateDate; string; The date and time when the service request was last updated.
  • LastUpdatedBy; string; The user who last updated the service request.
  • LastUpdatedByDisplayName; string; The display name of the user who last updated the service request.
  • LastUpdatedByEmailAddress; string; The e-mail address of the person who last updated the service request.
  • LastUpdatedByPartyId; integer; The unique party identifier of the person who last updated the service request.
  • MilestoneConfigId; integer; The unique identifier of the milestone configuration associated with the service request.
  • MilestoneLabel; string; The name of the milestone.
  • MilestoneStatusCd; string; The status of the milestone.
  • OpenDate; string; The date when the service request was reported by the customer.
  • OriginalSystemReference; string; The reference to the service request record in the original system from which service request was imported.
  • PrimaryContactAssignmentNumber; string; The unique assignment number of the primary contact of the service request.
  • PrimaryContactDoNotContactFlag; boolean; The primary contact of the service request doesn't want to be contacted.
  • PrimaryContactPartyId; integer; The unique identifier of the primary contact of the service request.
  • PrimaryContactPartyName; string; The name of the service request primary contact.
  • PrimaryContactPartyNumber; string; The alternative key for the primary contact identifier.
  • PrimaryContactPersonId; integer; The unique identifier of the primary contact of the service request.
  • PrimaryContactPersonIdTransient; string; The unique identifier of the primary contact of the service request.
  • PrimaryContactPreferredContactMethod; string; The preferred contact method of the primary contact of the service request.
  • ProblemCd; string; The problem code of the service request.
  • ProblemDescription; string; The service request's problem description or statement and the steps to reproduce the issue.
  • ProdGroupName; string; The name of the product group associated to the service request.
  • ProductGroupReferenceNumber; string; The alternative key for the product group identifier.
  • ProductItemDescription; string; The description of the product associated with the service request.
  • ProductItemNumber; string; The product number or code of the product associated with the service request.
  • QueueId; integer; The unique identifier of the queue to which the service request is assigned.
  • QueueName; string; The name of the queue associated to the service request.
  • QueueNumber; string; The alternative key for the queue identifier.
  • RecordSet; string; The record set used by REST API to run saved searches.
  • ReportedByEmailAddress; string; The e-mail address of the person who reported the service request.
  • ReportedByPartyId; integer; The user who created the request.
  • ReportedByPartyName; string; The name of the reported party.
  • ReportedByPartyNumber; string; The alternative key for the party identifier of the person reporting the service request.
  • ReportedByPartyUniqueName; string; The unique name of the user who created the service request.
  • ResolutionCd; string; The resolution code of the service request.
  • ResolutionCdMeaning; string; The display value corresponding to the resolution lookup code for the service request.
  • ResolveDescription; string; The description of how the service request has been resolved.
  • ResolveOutcomeCd; string; The outcome of a service request resolution.
  • ResolveOutcomeCdMeaning; string; The display value corresponding to the resolution outcome lookup code for the service request.
  • ResolvedBy; string; The user who resolved the service request.
  • ServiceZoneId; integer; The unique identifier of the service request region.
  • ServiceZoneName; string; The name of the service request region.
  • SeverityCd; string; The severity of the service request.
  • SeverityCdMeaning; string; The display value corresponding to the severity lookup code for the service request.
  • SeverityCdTransient; string; The severity of the service request.
  • SeverityRank; integer; The numeric code of the service request severity.
  • SourceCd; string; Indicates how the service request was created in the application.
  • SrId; integer; The unique identifier of the service request record.
  • SrMilestoneId; integer; The unique identifier of the milestone associated to the service request.
  • SrNumber; string; The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements.
  • StatusCd; string; The status code of the service request.
  • StatusCdMeaning; string; The display value corresponding to the status lookup code for the service request.
  • StatusTypeCd; string; The status type of the service request.
  • StatusTypeCdMeaning; string; The display value corresponding to the status type lookup code for the service request.
  • StripeCd; string; The application stripe of the service request.
  • SurveyResponseDate; string; The date and time when the response to this survey was submitted.
  • SurveySentDate; string; The date and time when survey was last sent for this service request.
  • TimeRemaining; string; The time remaining in the milestone.
  • TimezoneCode; string; The service request time zone optionally used for computing the milestone due date.
  • Title; string; The brief title of the service request.
  • TransferCount; integer; The count showing how many times a service request has been transferred.
  • TransferNote; string; This field contains information about transfer note.
  • TransferReasonCd; string; The lookup code that indicates the transfer reason.
  • UniqueExternalSystemReference; string; The unique alternative identifier of the service request in the original reference system. You can this column to store the identifier of the service request in the external application you're integrating with.
  • WarnedFlag; boolean; Indicates whether the milestone passed the warning threshold.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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 : hrHelpDeskRequests

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "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/hrHelpDeskRequests-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hrHelpDeskRequests-item-response

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

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 : hrHelpDeskRequests-item-response

Type: object

Show Source

• activities: array Activities
  Title: Activities

  The activities resource is used to view, create, update, and delete an activity.
• AffectedPartyAssignmentNumber: string
  Title: Affected Party Person Assignment Number

  Maximum Length: 50

  The unique assignment number of the affected party person for the service request.
• AffectedPartyPersonId: string
  Title: Affected Party

  The unique identifier of the affected party person.
• AffectedPartyPersonName: string
  Title: Affected Party Person Name

  Read Only: true

  The display name of the affected party person in the service request.
• AssigneeEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the assignee.
• AssigneeFormattedAddress: string
  Title: Assignee Formatted Address

  Read Only: true

  The formatted address of the SR assignee.
• AssigneeFormattedPhoneNumber: string
  Title: Assignee Phone

  Read Only: true

  The phone number of the resource to whom the service request is assigned.
• AssigneePartyId: integer (int64)
  Title: Assigned to Party ID

  Read Only: true

  The unique identifier of the assignee party.
• AssigneePersonName: string
  Title: Assigned To

  Maximum Length: 360

  The email address of the assignee.
• AssigneeResourceId: integer (int64)
  Title: Assigned to Resource ID

  The unique identifier of the assignee resource.
• AssigneeResourceNumber: string
  Title: Assigned to Resource Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the resource identifier of the assignee.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BUOrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit associated to the service request.
• BusinessUnitName: string
  Title: Business Unit Name

  Read Only: true

  Maximum Length: 255

  The name of the business unit associated to the service request
• CategoryCode: string
  Title: Category Code

  Read Only: true

  Maximum Length: 290

  Indicates the alternate key of the category associated to the service request.
• CategoryId: integer (int64)
  Title: Category

  The unique identifier of the service request category.
• CategoryName: string
  Title: Category Name

  Read Only: true

  Maximum Length: 400

  The name of the category associated to the service request.
• channelCommunication: array Service Request Message Communications
  Title: Service Request Message Communications

  The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
• ChannelId: integer
  Title: Channel

  The unique identifier of the service request channel.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The channel type.
• ChannelTypeCdMeaning: string
  Title: Channel Type Value

  Read Only: true

  Maximum Length: 255

  The display value corresponding to the channel type lookup code for the service request.
• ClosedDate: string (date-time)
  Title: Date Closed

  The date when the service request was closed, if closed.
• ComplianceFlag: boolean
  Title: Compliance

  Read Only: true

  The compliance status of the milestone.
• contacts: array Contact Members
  Title: Contact Members

  The list of contacts associated to the serivce request.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the service request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the service request was created.
• CriticalFlag: boolean
  Title: Critical

  Maximum Length: 1

  Default Value: false

  Indicates whether the service request is critical. If critical, the value is Y, else the value is N.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The corporate currency conversion rate type.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the user has access to delete the record
• DueDate: string (date-time)
  Title: Due Date

  Read Only: true

  The date when the milestone is due.
• FirstTransferDate: string (date-time)
  Title: First Transfer Date

  The date when the service request was first transferred.
• HeaderFlag: boolean
  Title: Header

  Read Only: true

  Maximum Length: 1

  Indicates whether the current milestone should be saved on the service request header.
• InternalPriorityCd: string
  Title: Internal Priority Code

  Maximum Length: 30

  The internal priority of the service request.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the product associated to the service request.
• InventoryOrgId: integer (int64)
  Title: Inventory Organization ID

  The unique identifier of the organization of the product that's associated with the service request.
• LanguageCd: string
  Title: Language Code

  Maximum Length: 30

  The customer's preferred language for the service request.
• LastReopenDate: string (date-time)
  Title: Date Reopened

  The date and time when the service request was last reopened.
• LastResolvedDate: string (date-time)
  Title: Resolution Date

  The date and time when the service request was resolved.
• LastTransferDate: string (date-time)
  Title: Last Transfer Date

  Indicates the date and time of the last transfer of the service request.
• LastTransferredBy: string
  Title: Last Transferred By

  Maximum Length: 64

  The user who last transferred the service request.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the service request was last updated.
• LastUpdatedBy: string
  Title: Last Updated by Login ID

  Read Only: true

  Maximum Length: 64

  The user who last updated the service request.
• LastUpdatedByDisplayName: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 3600

  The display name of the user who last updated the service request.
• LastUpdatedByEmailAddress: string
  Title: Last Updated by Email Address

  Read Only: true

  Maximum Length: 255

  The e-mail address of the person who last updated the service request.
• LastUpdatedByPartyId: integer (int64)
  The unique party identifier of the person who last updated the service request.
• LastUpdatedByPartyNumber: string
  Title: Last Updated by Party Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the party identifier of the person who last updated the service request.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the service request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• messages: array Messages
  Title: Messages

  The list of service request messages.
• MilestoneConfigId: integer (int64)
  Title: Configuration ID

  Read Only: true

  The unique identifier of the milestone configuration associated with the service request.
• MilestoneLabel: string
  Title: Milestone Name

  Read Only: true

  The name of the milestone.
• MilestoneStatusCd: string
  Title: Milestone Status

  Read Only: true

  Maximum Length: 255

  The status of the milestone.
• NetworkTypeCd: string
  Title: Network

  Read Only: true

  Maximum Length: 30

  The type of social network.
• OpenDate: string (date-time)
  Title: Date Reported

  The date when the service request was reported by the customer.
• OriginalSystemReference: string
  Maximum Length: 255

  The reference to the service request record in the original system from which service request was imported.
• OwnerTypeCd: string
  Title: Owner Type

  Maximum Length: 30

  The type of the service request owner. For example, the owner of the service request may be a customer or a partner.
• PrimaryContactAssignmentNumber: string
  Title: Primary Contact Person Assignment Number

  Maximum Length: 50

  The unique assignment number of the primary contact of the service request.
• PrimaryContactDoNotContactFlag: boolean
  Title: Primary Contact Do Not Contact

  Read Only: true

  Maximum Length: 1

  The primary contact of the service request doesn't want to be contacted.
• PrimaryContactEmailAddress: string
  Title: Primary Contact Email

  Read Only: true

  Maximum Length: 320

  The e-mail of the primary contact associated with the service request.
• PrimaryContactFormattedAddress: string
  Title: Primary Contact Formatted Address

  Read Only: true

  The formatted address of the primary contact of the service request.
• PrimaryContactFormattedPhoneNumber: string
  Title: Primary Contact Phone

  Read Only: true

  The service request primary contact's formatted phone number
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact ID

  The unique identifier of the primary contact of the service request.
• PrimaryContactPartyName: string
  Title: Primary Contact

  Read Only: true

  Maximum Length: 360

  The name of the service request primary contact.
• PrimaryContactPartyNumber: string
  Title: Primary Contact Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the primary contact identifier.
• PrimaryContactPersonId: integer (int64)
  Title: Primary Contact Person ID

  The unique identifier of the primary contact of the service request.
• PrimaryContactPersonIdTransient: string
  Title: Primary Point of Contact

  The unique identifier of the primary contact of the service request.
• PrimaryContactPreferredContactMethod: string
  Title: Primary Contact Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred contact method of the primary contact of the service request.
• ProblemCd: string
  Title: Problem Type Code

  Maximum Length: 30

  The problem code of the service request.
• ProblemDescription: string
  Title: Detailed Description

  Maximum Length: 1000

  The service request's problem description or statement and the steps to reproduce the issue.
• ProdGroupId: integer (int64)
  Title: Product Group ID

  The unique identifier of the product group associated to the service request.
• ProdGroupName: string
  Title: Product Group

  The name of the product group associated to the service request.
• ProductGroupReferenceNumber: string
  Title: Product Group Reference Number

  The alternative key for the product group identifier.
• ProductItemDescription: string
  Title: Product Description

  The description of the product associated with the service request.
• ProductItemNumber: string
  Title: Product Number

  Read Only: true

  Maximum Length: 255

  The product number or code of the product associated with the service request.
• ProductItemOrgId: integer (int64)
  Title: Product Organization

  Read Only: true

  The unique identifier of the product organization.
• QueueId: integer (int64)
  Title: Assigned Queue ID

  The unique identifier of the queue to which the service request is assigned.
• QueueName: string
  Title: Queue

  Maximum Length: 400

  The name of the queue associated to the service request.
• QueueNumber: string
  Title: Queue Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the queue identifier.
• RecordSet: string
  Title: Search Filter

  Read Only: true

  The record set used by REST API to run saved searches.
• ReportedByEmailAddress: string
  Title: Reported by Email ID

  Read Only: true

  Maximum Length: 320

  The e-mail address of the person who reported the service request.
• ReportedByFormattedPhoneNumber: string
  Title: Reported by Phone Number

  Read Only: true

  The formatted phone number of the person who reported the service request.
• ReportedByPartyId: integer (int64)
  Title: Reported by Party ID

  The user who created the request.
• ReportedByPartyName: string
  Title: Reported By

  Read Only: true

  Maximum Length: 360

  The name of the reported party.
• ReportedByPartyNumber: string
  Title: Reported by Party Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the party identifier of the person reporting the service request.
• ReportedByPartyUniqueName: string
  Title: Reported by Unique Name

  Read Only: true

  Maximum Length: 900

  The unique name of the user who created the service request.
• ResolutionCd: string
  Title: Resolution Code

  Maximum Length: 30

  The resolution code of the service request.
• ResolutionCdMeaning: string
  Title: Resolution Value

  Read Only: true

  The display value corresponding to the resolution lookup code for the service request.
• ResolvedBy: string
  Title: Resolved By

  Maximum Length: 64

  The user who resolved the service request.
• ResolveDescription: string
  Title: Solution Description

  Maximum Length: 1000

  The description of how the service request has been resolved.
• ResolveOutcomeCd: string
  Title: Outcome

  Maximum Length: 30

  The outcome of a service request resolution.
• ResolveOutcomeCdMeaning: string
  Title: Outcome Value

  Read Only: true

  The display value corresponding to the resolution outcome lookup code for the service request.
• resourceMembers: array Resources
  Title: Resources

  The list of resources associated to the service request.
• ServiceZoneId: integer (int64)
  Title: Region Identifier

  The unique identifier of the service request region.
• ServiceZoneName: string
  Title: Service Region

  Read Only: true

  Maximum Length: 360

  The name of the service request region.
• SeverityCd: string
  Title: Severity

  Maximum Length: 30

  The severity of the service request.
• SeverityCdMeaning: string
  Title: Severity Value

  Read Only: true

  The display value corresponding to the severity lookup code for the service request.
• SeverityCdTransient: string
  Title: Severity

  The severity of the service request.
• SeverityColorCd: string
  Title: Severity Color Code

  Read Only: true

  The color code for the severity of the service request.
• SeverityRank: integer
  Title: Severity Rank

  Read Only: true

  The numeric code of the service request severity.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  Indicates how the service request was created in the application.
• SrCreatedBy: string
  Title: Source System SR Created By

  Maximum Length: 64

  The user who created the service request.
• SrId: integer (int64)
  Title: Service Request ID

  Read Only: true

  The unique identifier of the service request record.
• srInteractionReferences: array Interaction References
  Title: Interaction References

  Indicates the list of interaction references for a service request.
• SrLastUpdateDate: string (date-time)
  Title: Last Update Date in Source System

  The date and time when the service request was last updated.
• SrLastUpdatedBy: string
  Title: Source System SR Last Updated By

  Maximum Length: 64

  The user who last updated the service request.
• SrLastUpdateLogin: string
  Title: Source System SR Last Updated by User Login ID

  Maximum Length: 32

  The login of the user who last updated the service request.
• srMilestone: array Milestones
  Title: Milestones

  Indicates the milestone associated with the service request.
• SrMilestoneId: integer (int64)
  Title: Milestone ID

  Read Only: true

  The unique identifier of the milestone associated to the service request.
• SrNumber: string
  Title: Request Number

  Maximum Length: 30

  The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements.
• srReferences: array References
  Title: References

  The list of other objects associated to the service request. E.g. Knowledge articles.
• srTags: array Tags
  Title: Tags

  The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.
• StatusCd: string
  Title: Status

  Maximum Length: 30

  The status code of the service request.
• StatusCdMeaning: string
  Title: Status Value

  Read Only: true

  The display value corresponding to the status lookup code for the service request.
• StatusTypeCd: string
  Title: Status Type

  Read Only: true

  Maximum Length: 30

  The status type of the service request.
• StatusTypeCdMeaning: string
  Title: Status Type Value

  Read Only: true

  The display value corresponding to the status type lookup code for the service request.
• StripeCd: string
  Maximum Length: 30

  Default Value: ORA_SVC_HRHD

  The application stripe of the service request.
• SurveyResponseDate: string (date-time)
  Title: Survey Response Date

  Read Only: true

  The date and time when the response to this survey was submitted.
• SurveySentDate: string (date-time)
  Title: Survey Sent Date

  Read Only: true

  The date and time when survey was last sent for this service request.
• TimeRemaining: string
  Title: Time Remaining

  Read Only: true

  The time remaining in the milestone.
• TimezoneCode: string
  Title: Time Zone Code

  Maximum Length: 50

  The service request time zone optionally used for computing the milestone due date.
• Title: string
  Title: Subject

  Maximum Length: 400

  The brief title of the service request.
• TransferCount: integer (int64)
  Title: Transfer Count

  The count showing how many times a service request has been transferred.
• TransferNote: string
  Title: Transfer Note

  Maximum Length: 1500

  This field contains information about transfer note.
• TransferReasonCd: string
  Title: Transfer Reason

  Maximum Length: 30

  The lookup code that indicates the transfer reason.
• UniqueExternalSystemReference: string
  Title: Unique External System Reference Number

  Maximum Length: 255

  The unique alternative identifier of the service request in the original reference system. You can this column to store the identifier of the service request in the external application you're integrating with.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record.
• WarnedFlag: boolean
  Title: Warned

  Read Only: true

  Indicates whether the milestone passed the warning threshold.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":"290",
            "type":"string",
            "description":"Indicates the alternate key of the category associated to the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group associated to the service request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupName":{
            "title":"Product Group",
            "type":"string",
            "description":"The name of the product group associated to the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProblemDescription":{
            "title":"Detailed Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The service request's problem description or statement and the steps to reproduce the issue.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"BaseRequestEO.ProblemDescription",
                "protectionObjectTitle":"Detailed Description",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Detailed Description"
            },
            "x-queryable":true
        },
        "ProductItemDescription":{
            "title":"Product Description",
            "type":"string",
            "description":"The description of the product associated with the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The corporate currency conversion rate type.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates how the service request was created in the application.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code.",
            "nullable":true,
            "x-queryable":false
        },
        "HeaderFlag":{
            "title":"Header",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the current milestone should be saved on the service request header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstTransferDate":{
            "title":"First Transfer Date",
            "type":"string",
            "description":"The date when the service request was first transferred.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactEmailAddress":{
            "title":"Primary Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail of the primary contact associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReportedByFormattedPhoneNumber":{
            "title":"Reported by Phone Number",
            "type":"string",
            "description":"The formatted phone number of the person who reported the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ReportedByPrimaryPhoneAreaCode",
                    "ReportedByPrimaryPhoneContactPtId",
                    "ReportedByPrimaryPhoneCountryCode",
                    "ReportedByPrimaryPhoneExtension",
                    "ReportedByPrimaryPhoneLineType",
                    "ReportedByPrimaryPhoneNumber"
                ]
            }
        },
        "OwnerTypeCd":{
            "title":"Owner Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the service request owner. For example, the owner of the service request may be a customer or a partner.",
            "nullable":true,
            "x-queryable":false
        },
        "SeverityColorCd":{
            "title":"Severity Color Code",
            "type":"string",
            "description":"The color code for the severity of the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SeverityCd"
                ]
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated by Login ID",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the product associated to the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactPersonId":{
            "title":"Primary Contact Person ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18",
                "dependencies":[
                    "PrimaryContactAssignmentNumber"
                ]
            },
            "x-queryable":true
        },
        "SurveyResponseDate":{
            "title":"Survey Response Date",
            "type":"string",
            "description":"The date and time when the response to this survey was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the organization of the product that's associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactPersonIdTransient":{
            "title":"Primary Point of Contact",
            "type":"string",
            "description":"The unique identifier of the primary contact of the service request.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPersonId"
                ]
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the primary contact identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneePersonName":{
            "title":"Assigned To",
            "maxLength":"360",
            "type":"string",
            "description":"The email address of the assignee.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "messages":{
            "title":"Messages",
            "type":"array",
            "description":"The list of service request messages.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-messages-item-response"
            }
        },
        "MilestoneConfigId":{
            "title":"Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the milestone configuration associated with the service request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ComplianceFlag":{
            "title":"Compliance",
            "type":"boolean",
            "description":"The compliance status of the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":"50",
            "type":"string",
            "description":"The service request time zone optionally used for computing the milestone due date.",
            "nullable":true,
            "x-queryable":true
        },
        "srReferences":{
            "title":"References",
            "type":"array",
            "description":"The list of other objects associated to the service request. E.g. Knowledge articles.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-srReferences-item-response"
            }
        },
        "AssigneeResourceId":{
            "title":"Assigned to Resource ID",
            "type":"integer",
            "description":"The unique identifier of the assignee resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "resourceMembers":{
            "title":"Resources",
            "type":"array",
            "description":"The list of resources associated to the service request.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-resourceMembers-item-response"
            }
        },
        "ResolveOutcomeCd":{
            "title":"Outcome",
            "maxLength":"30",
            "type":"string",
            "description":"The outcome of a service request resolution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the milestone associated to the service request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactAssignmentNumber":{
            "title":"Primary Contact Person Assignment Number",
            "maxLength":"50",
            "type":"string",
            "description":"The unique assignment number of the primary contact of the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeFormattedAddress":{
            "title":"Assignee Formatted Address",
            "type":"string",
            "description":"The formatted address of the SR assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AssigneeIdenAddrLocationId",
                    "AssigneeCountry",
                    "AssigneePersonalAddressFlag"
                ]
            }
        },
        "SrCreatedBy":{
            "title":"Source System SR Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the service request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "SrLastUpdatedBy":{
            "title":"Source System SR Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the service request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdatedBy"
                ]
            }
        },
        "channelCommunication":{
            "title":"Service Request Message Communications",
            "type":"array",
            "description":"The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-channelCommunication-item-response"
            }
        },
        "MilestoneLabel":{
            "title":"Milestone Name",
            "type":"string",
            "description":"The name of the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueExternalSystemReference":{
            "title":"Unique External System Reference Number",
            "maxLength":"255",
            "type":"string",
            "description":"The unique alternative identifier of the service request in the original reference system. You can this column to store the identifier of the service request in the external application you're integrating with.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCdMeaning":{
            "title":"Resolution Value",
            "type":"string",
            "description":"The display value corresponding to the resolution lookup code for the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ResolutionCd"
                ]
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "SeverityCdMeaning":{
            "title":"Severity Value",
            "type":"string",
            "description":"The display value corresponding to the severity lookup code for the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SeverityCd"
                ]
            },
            "x-queryable":true
        },
        "srInteractionReferences":{
            "title":"Interaction References",
            "type":"array",
            "description":"Indicates the list of interaction references for a service request.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-srInteractionReferences-item-response"
            }
        },
        "AssigneeFormattedPhoneNumber":{
            "title":"Assignee Phone",
            "type":"string",
            "description":"The phone number of the resource to whom the service request is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AssigneePrimaryPhoneAreaCode",
                    "AssigneePrimaryPhoneContactPtId",
                    "AssigneePrimaryPhoneCountryCode",
                    "AssigneePrimaryPhoneExtension",
                    "AssigneePrimaryPhoneLineType",
                    "AssigneePrimaryPhoneNumber"
                ]
            }
        },
        "ReportedByPartyNumber":{
            "title":"Reported by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the party identifier of the person reporting the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceZoneName":{
            "title":"Service Region",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the service request region.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StripeCd":{
            "maxLength":"30",
            "type":"string",
            "description":"The application stripe of the service request.",
            "nullable":false,
            "default":"ORA_SVC_HRHD",
            "x-queryable":true
        },
        "StatusTypeCd":{
            "title":"Status Type",
            "maxLength":"30",
            "type":"string",
            "description":"The status type of the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit associated to the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Date Closed",
            "type":"string",
            "description":"The date when the service request was closed, if closed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferDate":{
            "title":"Last Transfer Date",
            "type":"string",
            "description":"Indicates the date and time of the last transfer of the service request.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReportedByPartyId":{
            "title":"Reported by Party ID",
            "type":"integer",
            "description":"The user who created the request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "contacts":{
            "title":"Contact Members",
            "type":"array",
            "description":"The list of contacts associated to the serivce request.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-contacts-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the service request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "<>",
                    "BEFORE",
                    "AFTER",
                    "ONORBEFORE",
                    "ONORAFTER",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactFormattedAddress":{
            "title":"Primary Contact Formatted Address",
            "type":"string",
            "description":"The formatted address of the primary contact of the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactIdenAddrLocationId",
                    "PrimaryContactCountry",
                    "PrimaryContactPersonalAddressFlag"
                ]
            }
        },
        "LastUpdatedByPartyNumber":{
            "title":"Last Updated by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the party identifier of the person who last updated the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResolveDescription":{
            "title":"Solution Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of how the service request has been resolved.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"BaseRequestEO.ResolveDescription",
                "protectionObjectTitle":"Solution Description",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Solution Description"
            },
            "x-queryable":true
        },
        "OpenDate":{
            "title":"Date Reported",
            "type":"string",
            "description":"The date when the service request was reported by the customer.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-Attachment-item-response"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-smartActions-item-response"
            }
        },
        "ResolveOutcomeCdMeaning":{
            "title":"Outcome Value",
            "type":"string",
            "description":"The display value corresponding to the resolution outcome lookup code for the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ResolveOutcomeCd"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactFormattedPhoneNumber":{
            "title":"Primary Contact Phone",
            "type":"string",
            "description":"The service request primary contact's formatted phone number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPrimaryPhoneAreaCode",
                    "PrimaryContactPrimaryPhoneContactPtId",
                    "PrimaryContactPrimaryPhoneCountryCode",
                    "PrimaryContactPrimaryPhoneExtension",
                    "PrimaryContactPrimaryPhoneLineType",
                    "PrimaryContactPrimaryPhoneNumber"
                ]
            }
        },
        "LastUpdatedByDisplayName":{
            "title":"Last Updated By",
            "maxLength":"3600",
            "type":"string",
            "description":"The display name of the user who last updated the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LastUpdatedBy"
                ]
            },
            "x-queryable":true
        },
        "SrLastUpdateLogin":{
            "title":"Source System SR Last Updated by User Login ID",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the service request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdateLogin"
                ]
            }
        },
        "TransferNote":{
            "title":"Transfer Note",
            "maxLength":"1500",
            "type":"string",
            "description":"This field contains information about transfer note.",
            "nullable":true,
            "x-queryable":true
        },
        "ProblemCd":{
            "title":"Problem Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The problem code of the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordSet":{
            "title":"Search Filter",
            "type":"string",
            "description":"The record set used by REST API to run saved searches.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code.",
            "nullable":true,
            "x-queryable":false
        },
        "AffectedPartyPersonId":{
            "title":"Affected Party",
            "type":"string",
            "description":"The unique identifier of the affected party person.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AffectedPartyAssignmentNumber"
                ]
            }
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "type":"string",
            "description":"The alternative key for the product group identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportedByEmailAddress":{
            "title":"Reported by Email ID",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the person who reported the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ReportedByPartyName":{
            "title":"Reported By",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the reported party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AffectedPartyPersonName":{
            "title":"Affected Party Person Name",
            "type":"string",
            "description":"The display name of the affected party person in the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AffectedPartyPersonId"
                ]
            },
            "x-queryable":true
        },
        "SeverityCd":{
            "title":"Severity",
            "maxLength":"30",
            "type":"string",
            "description":"The severity of the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "Dependencies":"BUOrgId"
            },
            "x-queryable":true
        },
        "SeverityCdTransient":{
            "title":"Severity",
            "type":"string",
            "description":"The severity of the service request.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SeverityCd"
                ]
            },
            "x-queryable":true
        },
        "QueueId":{
            "title":"Assigned Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue to which the service request is assigned.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactDoNotContactFlag":{
            "title":"Primary Contact Do Not Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"The primary contact of the service request doesn't want to be contacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedByPartyUniqueName":{
            "title":"Reported by Unique Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the user who created the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeEmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "SurveySentDate":{
            "title":"Survey Sent Date",
            "type":"string",
            "description":"The date and time when survey was last sent for this service request.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByEmailAddress":{
            "title":"Last Updated by Email Address",
            "maxLength":"255",
            "type":"string",
            "description":"The e-mail address of the person who last updated the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "srTags":{
            "title":"Tags",
            "type":"array",
            "description":"The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-srTags-item-response"
            }
        },
        "LanguageCd":{
            "title":"Language Code",
            "maxLength":"30",
            "type":"string",
            "description":"The customer's preferred language for the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "AffectedPartyAssignmentNumber":{
            "title":"Affected Party Person Assignment Number",
            "maxLength":"50",
            "type":"string",
            "description":"The unique assignment number of the affected party person for the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeResourceNumber":{
            "title":"Assigned to Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the resource identifier of the assignee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "srMilestone":{
            "title":"Milestones",
            "type":"array",
            "description":"Indicates the milestone associated with the service request.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-srMilestone-item-response"
            }
        },
        "ChannelTypeCdMeaning":{
            "title":"Channel Type Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the channel type lookup code for the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ChannelTypeCd"
                ]
            },
            "x-queryable":true
        },
        "TransferReasonCd":{
            "title":"Transfer Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code that indicates the transfer reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":"30",
            "type":"string",
            "description":"The resolution code of the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ResolveOutcomeCd"
                ]
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The channel type.",
            "nullable":true,
            "x-queryable":true
        },
        "CriticalFlag":{
            "title":"Critical",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the service request is critical. If critical, the value is Y, else the value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SrLastUpdateDate":{
            "title":"Last Update Date in Source System",
            "type":"string",
            "description":"The date and time when the service request was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":false
        },
        "CategoryId":{
            "title":"Category",
            "type":"integer",
            "description":"The unique identifier of the service request category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "BUOrgId",
                    "StripeCd"
                ]
            },
            "x-queryable":true
        },
        "ProductItemOrgId":{
            "title":"Product Organization",
            "type":"integer",
            "description":"The unique identifier of the product organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":"30",
            "type":"string",
            "description":"The type of social network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WarnedFlag":{
            "title":"Warned",
            "type":"boolean",
            "description":"Indicates whether the milestone passed the warning threshold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SeverityRank":{
            "title":"Severity Rank",
            "type":"integer",
            "description":"The numeric code of the service request severity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastResolvedDate":{
            "title":"Resolution Date",
            "type":"string",
            "description":"The date and time when the service request was resolved.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransferCount":{
            "title":"Transfer Count",
            "type":"integer",
            "description":"The count showing how many times a service request has been transferred.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel",
            "type":"integer",
            "description":"The unique identifier of the service request channel.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactPreferredContactMethod":{
            "title":"Primary Contact Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred contact method of the primary contact of the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the service request primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov",
                "protectionKey":"PartyEO.PartyName",
                "protectionObjectTitle":"Primary Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Primary Contact"
            },
            "x-queryable":true
        },
        "AssigneePartyId":{
            "title":"Assigned to Party ID",
            "type":"integer",
            "description":"The unique identifier of the assignee party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when the milestone is due.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the business unit associated to the service request",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InternalPriorityCd":{
            "title":"Internal Priority Code",
            "maxLength":"30",
            "type":"string",
            "description":"The internal priority of the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the queue associated to the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "MilestoneStatusCd":{
            "title":"Milestone Status",
            "maxLength":"255",
            "type":"string",
            "description":"The status of the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusTypeCdMeaning":{
            "title":"Status Type Value",
            "type":"string",
            "description":"The display value corresponding to the status type lookup code for the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusTypeCd"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedByPartyId":{
            "type":"integer",
            "description":"The unique party identifier of the person who last updated the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "maxLength":"255",
            "type":"string",
            "description":"The reference to the service request record in the original system from which service request was imported.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SrNumber"
                ]
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Subject",
            "maxLength":"400",
            "type":"string",
            "description":"The brief title of the service request.",
            "nullable":false,
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements.",
            "nullable":false,
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the queue identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastReopenDate":{
            "title":"Date Reopened",
            "type":"string",
            "description":"The date and time when the service request was last reopened.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ResolvedBy":{
            "title":"Resolved By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who resolved the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "TimeRemaining":{
            "title":"Time Remaining",
            "type":"string",
            "description":"The time remaining in the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SrMilestoneId",
                    "MilestoneStatusCd",
                    "DueDate"
                ]
            },
            "x-queryable":true
        },
        "activities":{
            "title":"Activities",
            "type":"array",
            "description":"The activities resource is used to view, create, update, and delete an activity.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-activities-item-response"
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the category associated to the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastTransferredBy":{
            "title":"Last Transferred By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last transferred the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductItemNumber":{
            "title":"Product Number",
            "maxLength":"255",
            "type":"string",
            "description":"The product number or code of the product associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceZoneId":{
            "title":"Region Identifier",
            "type":"integer",
            "description":"The unique identifier of the service request region.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Activities

Type: array

Title: Activities

The activities resource is used to view, create, update, and delete an activity.

Show Source

• Array of: object hrHelpDeskRequests-activities-item-response

{
    "title":"Activities",
    "type":"array",
    "description":"The activities resource is used to view, create, update, and delete an activity.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-activities-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object hrHelpDeskRequests-Attachment-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-Attachment-item-response"
    }
}

Nested Schema : Service Request Message Communications

Type: array

Title: Service Request Message Communications

The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Show Source

• Array of: object hrHelpDeskRequests-channelCommunication-item-response

{
    "title":"Service Request Message Communications",
    "type":"array",
    "description":"The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-channelCommunication-item-response"
    }
}

Nested Schema : Contact Members

Type: array

Title: Contact Members

The list of contacts associated to the serivce request.

Show Source

• Array of: object hrHelpDeskRequests-contacts-item-response

{
    "title":"Contact Members",
    "type":"array",
    "description":"The list of contacts associated to the serivce request.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-contacts-item-response"
    }
}

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 : Messages

Type: array

Title: Messages

The list of service request messages.

Show Source

• Array of: object hrHelpDeskRequests-messages-item-response

{
    "title":"Messages",
    "type":"array",
    "description":"The list of service request messages.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-messages-item-response"
    }
}

Nested Schema : Resources

Type: array

Title: Resources

The list of resources associated to the service request.

Show Source

• Array of: object hrHelpDeskRequests-resourceMembers-item-response

{
    "title":"Resources",
    "type":"array",
    "description":"The list of resources associated to the service request.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-resourceMembers-item-response"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object hrHelpDeskRequests-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-smartActions-item-response"
    }
}

Nested Schema : Interaction References

Type: array

Title: Interaction References

Indicates the list of interaction references for a service request.

Show Source

• Array of: object hrHelpDeskRequests-srInteractionReferences-item-response

{
    "title":"Interaction References",
    "type":"array",
    "description":"Indicates the list of interaction references for a service request.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-srInteractionReferences-item-response"
    }
}

Nested Schema : Milestones

Type: array

Title: Milestones

Indicates the milestone associated with the service request.

Show Source

• Array of: object hrHelpDeskRequests-srMilestone-item-response

{
    "title":"Milestones",
    "type":"array",
    "description":"Indicates the milestone associated with the service request.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-srMilestone-item-response"
    }
}

Nested Schema : References

Type: array

Title: References

The list of other objects associated to the service request. E.g. Knowledge articles.

Show Source

• Array of: object hrHelpDeskRequests-srReferences-item-response

{
    "title":"References",
    "type":"array",
    "description":"The list of other objects associated to the service request. E.g. Knowledge articles.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-srReferences-item-response"
    }
}

Nested Schema : Tags

Type: array

Title: Tags

The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.

Show Source

• Array of: object hrHelpDeskRequests-srTags-item-response

{
    "title":"Tags",
    "type":"array",
    "description":"The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-srTags-item-response"
    }
}

Nested Schema : hrHelpDeskRequests-activities-item-response

Type: object

Show Source

• AccountAddress: string
  Title: Account Address

  Read Only: true

  The address associated with the account.
• AccountId: integer (int64)
  Title: Account ID

  The unique identifier of the account.
• AccountIdAttr: integer
  The internal attribute for the account Id.
• AccountName: string
  Title: Account

  The name of the account associated to activity.
• AccountNameOsn: string
  Title: Social Account Name

  The account name displayed in Oracle Social Network.
• AccountNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The account number of the account associated with the activity.
• AccountPhoneNumber: string
  Title: Account Phone Number

  Read Only: true

  The phone number associated with the account.
• AccountStatus: string
  Read Only: true

  Maximum Length: 1

  The status of the account.
• AccountType: string
  Read Only: true

  Maximum Length: 30

  The type of the account.
• ActivityCreatedBy: string
  Title: Activity Created By

  Read Only: true

  Maximum Length: 64

  The activity user who created the activity.
• ActivityCreationDate: string (date-time)
  Title: Activity Creation Date

  Read Only: true

  The date when the activity was created.
• ActivityDescription: string (byte)
  Title: Description

  A text field for capturing some descriptive information about the activity.
• ActivityDirection: string
  Read Only: true

  The direction of the interaction.
• ActivityEndDate: string (date-time)
  Title: End Date

  The end date and time of an appointment, or the completion time of a task.
• ActivityFilter: string
  Read Only: true

  An internal attribute to add additional activity filter.
• ActivityFunctionCode: string
  Title: Activity

  Maximum Length: 30

  The task vs appointment. This is for system use only.
• ActivityFunctionCodeTrans: string
  Title: Activity

  Maximum Length: 255

  The activity function code.
• ActivityId: integer (int64)
  Title: Activity ID

  System generated nonnullable primary key of the table.
• ActivityLastUpdateLogin: string
  Title: Activity Last Update Login

  Read Only: true

  Maximum Length: 32

  Original Activity Last Update Login
• ActivityMtgMinutes: string (byte)
  Title: Meeting Minutes

  The activity meeting minutes.
• ActivityNumber: string
  Title: Activity Number

  Maximum Length: 64

  The alternate identifier of the activity.
• ActivityOutcome: string
  Read Only: true

  The outcome of the activity.
• ActivityPartialDescription: string
  Title: Short Description

  Maximum Length: 4000

  A column that stores the first 4000 characters of activity description.
• ActivityPriority: string
  Title: Priority

  Indicates the priority of the activity (Internal Usage).
• ActivityStartDate: string (date-time)
  Title: Start Date

  The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task.
• ActivityStatus: string
  Title: Status

  Read Only: true

  The status of the activity.
• ActivitySubtypeCode: string
  Title: Subtype

  Maximum Length: 30

  Displays a list of subtype values that are dependent on the value of the activity.
• ActivityTimezone: string
  Represents the time zone that the activity needs to be created in, other than the default logged in user's timezone preference.
• ActivityType: string
  Title: Activity Type

  The type of the activity.
• ActivityTypeCode: string
  Title: Type

  Maximum Length: 30

  The type or category of the activity.
• ActivityUpdateDate: string (date-time)
  Title: Activity Updated Date

  Read Only: true

  The date when the activity was updated.
• ActivityUpdatedBy: string
  Title: Activity Updated By

  Read Only: true

  Maximum Length: 64

  The user who updated the activity.
• ActivityUserLastUpdateDate: string (date-time)
  Title: Activity User Last Updated Date

  Read Only: true

  The date when the activity was last updated.
• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: false

  Designates that an appointment is the entire day.
• AppointmentStatus: string
  Title: Appointment Status

  Maximum Length: 30

  The status of the appointment.
• ApptEndTime: string (date-time)
  Title: End Time

  The time when the activity ends.
• ApptStartTime: string (date-time)
  Title: Start Time

  The time when the activity starts.
• ArticleVersionId: string
  Title: Article Version ID

  Maximum Length: 64

  The unique identifier of the article version.
• AssessmentId: integer (int64)
  Title: Assessment ID

  The unique identifier of the assessment.
• AssetId: integer (int64)
  Title: Asset ID

  The unique identifier of the asset.
• AssetName: string
  Title: Asset

  The name of the asset.
• AssetNumber: string
  Title: Asset Number

  The alternate identifier of the asset.
• AssetSerialNumber: string
  Title: Asset Serial Number

  Read Only: true

  Maximum Length: 100

  The serial number of the asset.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: ZMM_ACTY_ACTIVITIES

  The name of the attachment entity.
• AutoLogSource: string
  Title: Source System

  Maximum Length: 30

  For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity.
• BpId: integer (int64)
  Title: Business Plan ID

  The unique identifier of the business plan.
• BuOrgId: integer (int64)
  Title: Business Unit

  The unique identifier for the Business Unit. This attribute is obsolete.
• BusinessPlanName: string
  Title: Business Plan

  The business plan name associated to the activity.
• BusinessPlanNumber: string
  Title: Business Plan Number

  The business plan number of the business plan associated with the activity.
• CalendarAccess: boolean
  The access rights to calendar. (Internal Usage)
• CalendarRecurType: string
  The activity recurrence type.
• CalendarSubject: string
  The activity subject.
• CalendarSubjectDay: string
  The title of the calendar.
• CalendarTimeType: string
  Indicates all day appointment. (Internal Usage)
• CallReportCount: integer (int32)
  Title: Call Report Count

  Default Value: 0

  A count of the number of call reports.
• CallReportUpcomingYN: string
  Indicates Y,N,M for upcoming appointments.
• CallReportYN: string
  Flag to Check if this activity has a Call Report
• CampaignId: integer (int64)
  Title: Campaign ID

  The unique identifier of the campaign.
• CampaignName: string
  Title: Campaign

  The name of the campaign associated to the activity.
• CampaignNumber: string
  Title: Campaign Number

  The campaign number of the campaign associated with the activity.
• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case.
• CaseNumber: string
  Title: Case Number

  The alternate identifier of the case.
• CaseTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 400

  The title of the case.
• CheckedInBy: string
  Title: Checked-In By

  Maximum Length: 64

  The name of the person who checks-in to a location.
• CheckedOutBy: string
  Title: Checked-Out By

  Maximum Length: 64

  The name of the person who checks-out to a location.
• CheckinDate: string (date-time)
  Title: Check-In Time

  Stores the date and time when a user checks in to an appointment.
• CheckinLatitude: number
  Title: Check-In Latitude

  Stores the latitude of a location where a user checks in to an appointment.
• CheckinLongitude: number
  Title: Check-In Longitude

  Stores the longitude of a location where a user checks in to an appointment.
• CheckoutDate: string (date-time)
  Title: Check-Out Time

  Stores the date and time when a user checks out of an appointment.
• CheckoutLatitude: number
  Title: Check-Out Latitude

  Stores the latitude of a location where a user checks out of an appointment.
• CheckoutLongitude: number
  Title: Check-Out Longitude

  Stores the longitude of a location where a user checks out of an appointment.
• ClaimId: integer (int64)
  Title: Claim ID

  The unique identifier of the claim.
• ClaimName: string
  Title: MDF Claim

  The name associated to the activity.
• ClaimNumber: string
  Title: Claim Number

  The number of the claim associated with the activity.
• ConflictId: integer (int64)
  Default Value: 0

  The unique internal identifier of the conflict
• ContactIDAttr: integer
  The internal contact identifier.
• ContactNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The contact number of primary contact associated with the activity.
• CorpCurrencyCode: string
  Title: Corporate Currency

  Maximum Length: 15

  The corporate currency code from profile.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the activity.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Attribute to capture the Date and Time the activity was created. This is defaulted by the application.
• CurcyConvRateType: string
  Title: Currency Conversion Rate

  Maximum Length: 30

  Holds the currency code of a record.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Holds the currency conversion rate type from profile.
• CurrentDateForCallReport: string (date-time)
  The current date for the call report.
• CurrentDateForCallReportAttr: string (date-time)
  The internal attribute for the current date for the call report.
• CurrentSystemDtTransient: string (date)
  Read Only: true

  The current system date,
• CustomerAccountId: integer (int64)
  Title: Customer Account ID

  The unique identifier of the customer account.
• DealId: integer (int64)
  Title: Deal ID

  The unique identifier of the related deal.
• DealNumber: string
  Title: Deal Registration

  The deal number associated to the activity.
• DelegatorId: integer (int64)
  Title: Delegator ID

  The activity resource that delegated activity ownership to another resource.
• DelegatorName: string
  Title: Delegated By

  The name of activity resource that delegated activity ownership to another resource.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the user has access to delete the record.
• DerivedAccountId: integer
  The unique identifier of the derived account.
• DirectionCode: string
  Title: Direction

  Maximum Length: 30

  The inbound or outbound. It's optional. The default is null.
• DismissAssignee: string
  Title: Dismissed

  Indicates whether the assignees is dismissed. Valid values are Y and N.
• DismissFlag: boolean
  Title: Dismissed

  Maximum Length: 1

  Indicates whether this activity is dismissed.
• DoNotCallFlag: boolean
  Read Only: true

  Flag to indicate if primary Contact can be called.
• DueDate: string (date)
  Title: Due Date

  The date the task activity is due to be completed.
• Duration: number
  Title: Duration

  The duration of an appointment or task.
• DynamicClaimLOVSwitcher: string
  Read Only: true

  The unique identifier of the account.
• EmailSentDate: string (date-time)
  This field is used to capture the Activity Email Notification shared date for Outlook integration.
• EndDateForCallReport: string (date-time)
  The end date of the call report.
• EndDateForCallReportAttr: string (date-time)
  The internal attribute for end date of the call report.
• EndDtRFAttr: string (date-time)
  The internal attribute for activity start date.
• ExternalContactEmail: string
  Title: Primary Email

  Maximum Length: 320

  The email address of an external contact.
• ExternalContactName: string
  Title: External Contact Name

  Maximum Length: 360

  The name of an external contact.
• ExternallyOwnedFlag: boolean
  Title: Externally Owned

  Maximum Length: 1

  Default Value: false

  Indicates that the activity isn't created by an internal resource.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The unique identifier of the fund request.
• FundRequestName: string
  Title: MDF Request

  The fund request name associated to the activity.
• FundRequestNumber: string
  Title: Fund Request Number

  The fund request number of the fund request associated with the activity.
• IbAssetId: integer (int64)
  Title: IB Asset ID

  The unique identifier of the installed base asset associated with the activity.
• IbAssetNumber: string
  Title: Installed Base Asset

  The number of the installed base asset associated with the activity.
• IbAssetSerialNumber: string
  Title: Installed Base Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the installed base asset associated with the activity.
• InstNumDerivedFrom: string
  Default Value: Y

  The internal attribute to identify recurrence mode.
• IsClientService: string
  Default Value: Y

  The obsolete internal attribute.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The attribute to capture the date and time the activity was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The attribute to capture the identifier of the user who last updated the activity.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The attribute to capture the identifiers of the user who last updated the activity.
• LeadId: integer (int64)
  Title: Lead ID

  Indicates the related lead to the activity.
• LeadIdAttr: integer
  The internal attribute for the lead Id.
• LeadName: string
  Title: Lead

  Indicates the lead name.
• LeadNameOsn: string
  Title: Social Lead Name

  The lead name displayed in Oracle Social Network.
• LeadNumber: string
  Title: Lead Number

  The lead number of lead associated with the activity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Title: Location

  Maximum Length: 200

  Indicates the location of an appointment.
• LocationId: integer (int64)
  Title: Location ID

  The location or address ID of the activity account or primary contact.
• LoginUserRFAttr: integer
  The internal attribute for activity login user.
• MdfRequestId: integer
  The identifier for fund request.
• MobileActivityCode: string
  Title: Mobile Activity Code

  Maximum Length: 50

  The unique identifier of external mobile device.
• NotesLinkSourceCodeTransient: string
  Read Only: true

  The note source object.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier of the objective.
• OpportunityId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the related opportunity.
• OpportunityIdAttr: integer
  The internal attribute for the opportunity Id.
• OpportunityName: string
  Title: Opportunity

  The name of opportunity associated to the activity.
• OpportunityNameOsn: string
  Title: Social Opportunity Name

  The opportunity name displayed in Oracle Social Network.
• OpportunityNumber: string
  Title: Opportunity Number

  The opportunity number of the opportunity associated with the activity.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier to identify the orchestration process.
• OrchestrationStepId: integer (int64)
  Title: Orchestration Step ID

  The unique identifier to identify the orchestration step.
• OrigEntityCode: string
  Maximum Length: 30

  Default Value: ACTIVITY

  The column to store the source of activity record during upgrade.
• OrigEntityNumber: string
  Maximum Length: 64

  The column to store the original user key of the object being upgraded to Activity.
• OsnActivityId: integer (int64)
  The unique activity identifier.
• OtherPartyPhoneNumber: string
  Title: Other Party Phone Number

  Maximum Length: 40

  For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called.
• OutcomeCode: string
  Title: Outcome

  Maximum Length: 30

  The code of the outcome of the activity.
• OutlookAutoSyncFlag: boolean
  Title: Microsoft Auto-Synchronization

  Maximum Length: 1

  Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365.
• OutlookFlag: boolean
  Title: Outlook

  Maximum Length: 1

  Default Value: false

  Indicates whether the activity was created from Outlook and synced.
• OutlookGlobalId: string
  Title: Outlook Global ID

  Maximum Length: 1024

  The unique identifier of an appointment created from Microsoft 365.
• OutlookIdentifier: string
  Title: Outlook Identifier

  Maximum Length: 1024

  The unique identifier from outlook activity.
• OwnerAddress: string
  Title: Activity Owner Address

  Read Only: true

  The activity owner's address.
• OwnerEmailAddress: string
  Title: Activity Owner Email

  Read Only: true

  Maximum Length: 320

  The activity owner's email address.
• OwnerId: integer (int64)
  Title: Owner ID

  The primary resource on the activity. Supports resources only.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The name of primary resource of activity.
• OwnerNameOsn: string
  Title: Social Owner Name

  The owner name displayed in Oracle Social Network.
• OwnerPhoneNumber: string
  Title: Activity Owner Phone Number

  Read Only: true

  The activity owner's phone number.
• ParentActivityId: integer (int64)
  Title: Parent ID

  The related activity identifier, only applicable if the record is a follow up activity.
• ParentActivityIdAttr: string
  The internal attribute for the parent activity Id.
• PartialMtgMinutes: string
  Title: Short Meeting Minutes

  Maximum Length: 4000

  A column that stores a truncated string of the meeting minutes.
• PartnerEnrollmentId: integer (int64)
  Title: Enrollment ID

  The unique identifier of the partner enrollment.
• PartnerEnrollmentNumber: string
  Title: Enrollment Number

  The surrogate key for partner enrollment.
• PartnerPartyId: integer (int64)
  Title: Partner Party ID

  The party identifier of the partner organization.
• PartnerPartyName: string
  Title: Partner

  Maximum Length: 80

  The party name of the partner organization.
• PartnerPartyNumber: string
  Title: Partner Number

  The partner party number of partner associated with the activity.
• PartnerProgramId: integer (int64)
  Title: Partner Program ID

  The related partner program.
• PartnerProgramName: string
  Title: Program

  The name of partner program associated to the activity.
• PartnerProgramNumber: string
  Title: Program Number

  The partner program number of partner program associated with the activity.
• PartnerUsageFlag: boolean
  Title: Partner Usage

  Maximum Length: 1

  Default Value: false

  Flag to indicate that the Activity has been created for an Organization Account with usage as Partner.
• PercentageComplete: number
  Title: Percentage Complete

  Default Value: 0

  The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end.
• PrimaryContactEmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Hold the email identifier of the primary contact.
• PrimaryContactId: integer (int64)
  Title: Primary Contact ID

  The primary contact of the activity.
• PrimaryContactName: string
  Title: Primary Contact

  The name of the primary contact.
• PrimaryContactNameOsn: string
  Title: Social Primary Contact Name

  The primary contact name displayed in Oracle Social Network.
• PrimaryFormattedAddress: string
  Title: Primary Contact Address

  Read Only: true

  The address of the primary contact.
• PrimaryFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the primary contact.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  The priority of the activity. Default to 2. Possible values: 1, 2, 3.
• PrivateFlag: boolean
  Title: Private

  Maximum Length: 1

  Indicates whether the activity is private.
• RecordSet: string
  Title: Record Set

  Maximum Length: 255

  The set of records to display in activity search.
• RecurDay: integer (int64)
  Title: Day

  Repeat on specified day of month for monthly appointments.
• RecurEndDate: string (date-time)
  Title: Ends

  Ends on a specified date.
• RecurEveryOptionFlag: boolean
  Title: Recurrence Option

  Maximum Length: 1

  It's set to indicate if the recurrence occurs for every day, month, year, and so on. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it's everyday of the week, it's set to Y if it's weekdays only, it's set to N.
• RecurExceptionFlag: boolean
  Title: Recurrence Exception

  Maximum Length: 1

  Indicates if appointment instance has been updated outside of recurring appointment series.
• RecurFrequency: number
  Title: Repeat

  Frequency that the recurring appointment series repeats.
• RecurFriFlag: boolean
  Title: Friday

  Maximum Length: 1

  Repeat on Friday.
• RecurMonFlag: boolean
  Title: Monday

  Maximum Length: 1

  Repeat on Monday.
• RecurMonth: string
  Title: Month

  Maximum Length: 30

  Repeat on specified month (for yearly appointments).
• RecurNumberOfInstances: number
  Title: Number of Instances

  Designates specific number of occurrences for the series to end after.
• RecurOrigInstDate: string (date-time)
  Title: Original Instance Date

  Original date of a recurring appointment instance.
• RecurPattern: string
  Title: Pattern

  Maximum Length: 30

  Designates which week for appointment to recur for monthly and yearly appointments. Possible values: First, Second, Third, Fourth, Last.
• RecurRecType: string
  Title: Recurrence Record Type

  Maximum Length: 1

  Default Value: N

  For Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task.
• RecurSatFlag: boolean
  Title: Saturday

  Maximum Length: 1

  Repeat on Saturday.
• RecurSeriesId: integer (int64)
  Title: Recurrence Series ID

  Series Id that links instances of a series together.
• RecurSunFlag: boolean
  Title: Sunday

  Maximum Length: 1

  Repeat on Sunday.
• RecurThuFlag: boolean
  Title: Thursday

  Maximum Length: 1

  Repeat on Thursday.
• RecurTueFlag: boolean
  Title: Tuesday

  Maximum Length: 1

  Repeat on Tuesday.
• RecurTypeCode: string
  Title: Recurrence Type

  Maximum Length: 30

  Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly.
• RecurUpdatedAttributes: string
  Title: Recurrence Updated Attributes

  Maximum Length: 4000

  The updated field references for recurring appointment exception records.
• RecurWedFlag: boolean
  Title: Wednesday

  Maximum Length: 1

  Repeat on Wednesday.
• RecurWeekday: string
  Title: Pattern Type

  Maximum Length: 30

  It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day.
• ReferenceCustomerActTypeCode: string
  Title: Reference Customer Activity Type

  Maximum Length: 30

  The activity type for a reference customer activity. To be used as an extension only.
• ReferenceCustomerId: integer (int64)
  Title: Reference Customer

  The identifier of the reference customer party associated with the activity.
• ReminderPeriod: string
  Title: Set Reminder

  The reminder period.
• ResourceNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  The resource number of owner associated with the activity.
• ResponseCode: string
  Title: Response

  The response code.
• SalesObjectiveName: string
  Title: Sales Objective

  The sales objective name associated to the activity.
• SalesObjectiveNumber: string
  Title: Sales Objective Number

  The sales objective number of the sales objective associated with the activity.
• SearchDate: string (date-time)
  The date filter used in search (Internal Usage).
• SelectedFlag: boolean
  Default Value: false

  The records selected for Mass Update (Internal Usage).
• ShowStatus: string
  Title: Show

  Maximum Length: 255

  Indicates whether the activity is open, complete, or all activities.
• ShowTimeAs: string
  Title: Show Time As

  The show time of the activity.
• SmartActionContext: string
  Title: Smart Action Context

  Maximum Length: 4000

  Stores metadata needed for smart action.
• SmartActionId: integer (int64)
  Title: Smart Action ID

  The smart action Identifier. Foreign key from zca_user_action.
• SortDate: string (date-time)
  Title: Date

  This is an internal column which is used to sort the activity based on the due date for task and start date for activity.
• SourceObjectCode: string
  The code of the object to which activity will get related to.
• SourceObjectId: integer
  The identifier of the object to which activity will get related to.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request.
• SrNumber: string
  Title: Service Request

  The service request number.
• StartDateForCallReport: string (date-time)
  The start date of the call report.
• StartDateForCallReportAttr: string (date-time)
  The internal attribute for start date of the call report.
• StartDtRFAttr: string (date-time)
  The internal attribute for Activity Start Date.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Status of the activity. Defaulted to NOT_STARTED.
• Subject: string
  Title: Subject

  Maximum Length: 500

  The subject of the activity.
• SubmittedBy: integer (int64)
  Title: Submitted By

  The call report submitter.
• SubmittedByName: string
  Title: Submitted By

  Maximum Length: 255

  The name of the call report submitter.
• SubmittedDate: string (date-time)
  Title: Submitted Date

  The call report submission date.
• SwitchCallId: string
  Title: Switch Call ID

  Maximum Length: 128

  The unique identifier of the call on the external phone system.
• TaskReminderPeriod: string
  Title: Due Date Reminder

  The task reminder period.
• TemplateDuration: number
  Title: Template Duration

  The duration in days of the template activity. This attribute is used with the start date when generating an activity from a template to calculate the due date.
• TemplateFlag: string
  Title: Template

  Maximum Length: 1

  Default Value: N

  Indicates whether this is a template activity.
• TemplateId: integer (int64)
  Title: Template ID

  The unique identifier of the template.
• TemplateLeadTime: number
  Title: Lead Time

  The lead time in days of the template activity. This attribute is used with the date input parameter when generating an activity from a template to calculate the activity start date. Activity start date is equal date provided as input parameter and lead time.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the user has access to update the record.
• UpgSourceObjectId: string
  Read Only: true

  Maximum Length: 64

  The primary key value of the record in the source table that is upgraded to Rel9 Activity record.
• UpgSourceObjectType: string
  Read Only: true

  Maximum Length: 30

  The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record
• WebConferenceDetails: string (byte)
  Title: Web Conference Details

  The web conference details.
• WebConferenceId: string
  Title: Web Conference ID

  Maximum Length: 255

  The unique identifier of the web conference.
• WebConferenceURL: string
  Title: Web Conference URL

  Maximum Length: 2000

  The web conference join URL.
• WebconfSyncStatusFlag: boolean
  Title: Web Conference Synchronization

  Maximum Length: 1

  The appointment interaction status.

{
    "type":"object",
    "properties":{
        "OpportunityNameOsn":{
            "title":"Social Opportunity Name",
            "type":"string",
            "description":"The opportunity name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OpportunityName"
                ]
            }
        },
        "CheckedOutBy":{
            "title":"Checked-Out By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the person who checks-out to a location.",
            "nullable":true,
            "x-queryable":true
        },
        "FundRequestNumber":{
            "title":"Fund Request Number",
            "type":"string",
            "description":"The fund request number of the fund request associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "CallReportCount":{
            "title":"Call Report Count",
            "type":"integer",
            "description":"A count of the number of call reports.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AccountNameOsn":{
            "title":"Social Account Name",
            "type":"string",
            "description":"The account name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AccountName"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate",
            "maxLength":"30",
            "type":"string",
            "description":"Holds the currency code of a record.",
            "nullable":true,
            "x-queryable":false
        },
        "WebConferenceId":{
            "title":"Web Conference ID",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the web conference.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Holds the currency conversion rate type from profile.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactEmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"Hold the email identifier of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ShowStatus":{
            "title":"Show",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether the activity is open, complete, or all activities.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PercentageComplete":{
            "title":"Percentage Complete",
            "type":"number",
            "description":"The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "SmartActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The smart action Identifier. Foreign key from zca_user_action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartialMtgMinutes":{
            "title":"Short Meeting Minutes",
            "maxLength":"4000",
            "type":"string",
            "description":"A column that stores a truncated string of the meeting minutes.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The attribute to capture the identifier of the user who last updated the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurFrequency":{
            "title":"Repeat",
            "type":"number",
            "description":"Frequency that the recurring appointment series repeats.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityPriority":{
            "title":"Priority",
            "type":"string",
            "description":"Indicates the priority of the activity (Internal Usage).",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriorityCode"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityFunctionCode":{
            "title":"Activity",
            "maxLength":"30",
            "type":"string",
            "description":"The task vs appointment. This is for system use only.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerAddress":{
            "title":"Activity Owner Address",
            "type":"string",
            "description":"The activity owner's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The related partner program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactNameOsn":{
            "title":"Social Primary Contact Name",
            "type":"string",
            "description":"The primary contact name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactName"
                ]
            }
        },
        "RecurFriFlag":{
            "title":"Friday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Repeat on Friday.",
            "nullable":true,
            "x-queryable":false
        },
        "ApptStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the activity starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarSubjectDay":{
            "type":"string",
            "description":"The title of the calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentDateForCallReportAttr":{
            "type":"string",
            "description":"The internal attribute for the current date for the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DelegatorId":{
            "title":"Delegator ID",
            "type":"integer",
            "description":"The activity resource that delegated activity ownership to another resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecurWeekday":{
            "title":"Pattern Type",
            "maxLength":"30",
            "type":"string",
            "description":"It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BpId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseTitle":{
            "title":"Title",
            "maxLength":"400",
            "type":"string",
            "description":"The title of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurTueFlag":{
            "title":"Tuesday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Repeat on Tuesday.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The attribute to capture the identifiers of the user who last updated the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"integer",
            "description":"The unique identifier of the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceCustomerActTypeCode":{
            "title":"Reference Customer Activity Type",
            "maxLength":"30",
            "type":"string",
            "description":"The activity type for a reference customer activity. To be used as an extension only.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"System generated nonnullable primary key of the table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityCreationDate":{
            "title":"Activity Creation Date",
            "type":"string",
            "description":"The date when the activity was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerUsageFlag":{
            "title":"Partner Usage",
            "maxLength":"1",
            "type":"boolean",
            "description":"Flag to indicate that the Activity has been created for an Organization Account with usage as Partner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "TaskReminderPeriod":{
            "title":"Due Date Reminder",
            "type":"string",
            "description":"The task reminder period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstNumDerivedFrom":{
            "type":"string",
            "description":"The internal attribute to identify recurrence mode.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OpportunityId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the related opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDtRFAttr":{
            "type":"string",
            "description":"The internal attribute for Activity Start Date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SmartActionContext":{
            "title":"Smart Action Context",
            "maxLength":"4000",
            "type":"string",
            "description":"Stores metadata needed for smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "IbAssetId":{
            "title":"IB Asset ID",
            "type":"integer",
            "description":"The unique identifier of the installed base asset associated with the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResponseCode":{
            "title":"Response",
            "type":"string",
            "description":"The response code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IsClientService":{
            "type":"string",
            "description":"The obsolete internal attribute.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "IbAssetSerialNumber":{
            "title":"Installed Base Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The serial number of the installed base asset associated with the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type or category of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist",
                "Dependencies":"ActivityFunctionCode"
            },
            "x-queryable":true
        },
        "OutlookAutoSyncFlag":{
            "title":"Microsoft Auto-Synchronization",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ActivityMtgMinutes":{
            "title":"Meeting Minutes",
            "type":"string",
            "description":"The activity meeting minutes.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "SortDate":{
            "title":"Date",
            "type":"string",
            "description":"This is an internal column which is used to sort the activity based on the due date for task and start date for activity.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SalesObjectiveNumber":{
            "title":"Sales Objective Number",
            "type":"string",
            "description":"The sales objective number of the sales objective associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentActivityIdAttr":{
            "type":"string",
            "description":"The internal attribute for the parent activity Id.",
            "nullable":true,
            "x-queryable":true
        },
        "IbAssetNumber":{
            "title":"Installed Base Asset",
            "type":"string",
            "description":"The number of the installed base asset associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The resource number of owner associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The identifier of the object to which activity will get related to.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceCustomerId":{
            "title":"Reference Customer",
            "type":"integer",
            "description":"The identifier of the reference customer party associated with the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CheckedInBy":{
            "title":"Checked-In By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the person who checks-in to a location.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The attribute to capture the date and time the activity was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivedAccountId":{
            "type":"integer",
            "description":"The unique identifier of the derived account.",
            "nullable":true,
            "x-queryable":false
        },
        "OutcomeCode":{
            "title":"Outcome",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the outcome of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerEnrollmentNumber":{
            "title":"Enrollment Number",
            "type":"string",
            "description":"The surrogate key for partner enrollment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternallyOwnedFlag":{
            "title":"Externally Owned",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the activity isn't created by an internal resource.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "OutlookIdentifier":{
            "title":"Outlook Identifier",
            "maxLength":"1024",
            "type":"string",
            "description":"The unique identifier from outlook activity.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the activity. Defaulted to NOT_STARTED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DelegatorName":{
            "title":"Delegated By",
            "type":"string",
            "description":"The name of activity resource that delegated activity ownership to another resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CheckinLatitude":{
            "title":"Check-In Latitude",
            "type":"number",
            "description":"Stores the latitude of a location where a user checks in to an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The contact number of primary contact associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateForCallReport":{
            "type":"string",
            "description":"The end date of the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecordSet":{
            "title":"Record Set",
            "maxLength":"255",
            "type":"string",
            "description":"The set of records to display in activity search.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WebconfSyncStatusFlag":{
            "title":"Web Conference Synchronization",
            "maxLength":"1",
            "type":"boolean",
            "description":"The appointment interaction status.",
            "nullable":true,
            "x-queryable":true
        },
        "OutlookGlobalId":{
            "title":"Outlook Global ID",
            "maxLength":"1024",
            "type":"string",
            "description":"The unique identifier of an appointment created from Microsoft 365.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerPartyId":{
            "title":"Partner Party ID",
            "type":"integer",
            "description":"The party identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivitySubtypeCode":{
            "title":"Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"Displays a list of subtype values that are dependent on the value of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ActivityTypeCode",
                    "ActivityFunctionCode"
                ]
            },
            "x-queryable":true
        },
        "SalesObjectiveName":{
            "title":"Sales Objective",
            "type":"string",
            "description":"The sales objective name associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Duration":{
            "title":"Duration",
            "type":"number",
            "description":"The duration of an appointment or task.",
            "nullable":true,
            "x-queryable":false
        },
        "SubmittedByName":{
            "title":"Submitted By",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the call report submitter.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerPhoneNumber":{
            "title":"Activity Owner Phone Number",
            "type":"string",
            "description":"The activity owner's phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssetName":{
            "title":"Asset",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":"100",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckoutLongitude":{
            "title":"Check-Out Longitude",
            "type":"number",
            "description":"Stores the longitude of a location where a user checks out of an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityName":{
            "title":"Opportunity",
            "type":"string",
            "description":"The name of opportunity associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "OpportunityId"
                ]
            },
            "x-queryable":true
        },
        "OtherPartyPhoneNumber":{
            "title":"Other Party Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerEmailAddress":{
            "title":"Activity Owner Email",
            "maxLength":"320",
            "type":"string",
            "description":"The activity owner's email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "OwnerNameOsn":{
            "title":"Social Owner Name",
            "type":"string",
            "description":"The owner name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerName"
                ]
            }
        },
        "ActivityUserLastUpdateDate":{
            "title":"Activity User Last Updated Date",
            "type":"string",
            "description":"The date when the activity was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateFlag":{
            "title":"Template",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this is a template activity.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "OutlookFlag":{
            "title":"Outlook",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the activity was created from Outlook and synced.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RecurUpdatedAttributes":{
            "title":"Recurrence Updated Attributes",
            "maxLength":"4000",
            "type":"string",
            "description":"The updated field references for recurring appointment exception records.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutDate":{
            "title":"Check-Out Time",
            "type":"string",
            "description":"Stores the date and time when a user checks out of an appointment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerEnrollmentId":{
            "title":"Enrollment ID",
            "type":"integer",
            "description":"The unique identifier of the partner enrollment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The call report submission date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerPartyNumber":{
            "title":"Partner Number",
            "type":"string",
            "description":"The partner party number of partner associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurEveryOptionFlag":{
            "title":"Recurrence Option",
            "maxLength":"1",
            "type":"boolean",
            "description":"It's set to indicate if the recurrence occurs for every day, month, year, and so on. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it's everyday of the week, it's set to Y if it's weekdays only, it's set to N.",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WebConferenceDetails":{
            "title":"Web Conference Details",
            "type":"string",
            "description":"The web conference details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerPartyName":{
            "title":"Partner",
            "maxLength":"80",
            "type":"string",
            "description":"The party name of the partner organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RecurRecType":{
            "title":"Recurrence Record Type",
            "maxLength":"1",
            "type":"string",
            "description":"For Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ActivityOutcome":{
            "type":"string",
            "description":"The outcome of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OutcomeCode"
                ]
            }
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"Indicates the related lead to the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecurPattern":{
            "title":"Pattern",
            "maxLength":"30",
            "type":"string",
            "description":"Designates which week for appointment to recur for monthly and yearly appointments. Possible values: First, Second, Third, Fourth, Last.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier to identify the orchestration process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request",
            "type":"string",
            "description":"The service request number.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SrId"
                ]
            },
            "x-queryable":true
        },
        "MdfRequestId":{
            "type":"integer",
            "description":"The identifier for fund request.",
            "nullable":true,
            "x-queryable":false
        },
        "Subject":{
            "title":"Subject",
            "maxLength":"500",
            "type":"string",
            "description":"The subject of the activity.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "AccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The account number of the account associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date and time of an appointment, or the completion time of a task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReminderPeriod":{
            "title":"Set Reminder",
            "type":"string",
            "description":"The reminder period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurNumberOfInstances":{
            "title":"Number of Instances",
            "type":"number",
            "description":"Designates specific number of occurrences for the series to end after.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadName":{
            "title":"Lead",
            "type":"string",
            "description":"Indicates the lead name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "LeadId"
                ]
            },
            "x-queryable":true
        },
        "StartDateForCallReportAttr":{
            "type":"string",
            "description":"The internal attribute for start date of the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecurSeriesId":{
            "title":"Recurrence Series ID",
            "type":"integer",
            "description":"Series Id that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Location":{
            "title":"Location",
            "maxLength":"200",
            "type":"string",
            "description":"Indicates the location of an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Attribute to capture the Date and Time the activity was created. This is defaulted by the application.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the related deal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CheckinDate":{
            "title":"Check-In Time",
            "type":"string",
            "description":"Stores the date and time when a user checks in to an appointment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MobileActivityCode":{
            "title":"Mobile Activity Code",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of external mobile device.",
            "nullable":true,
            "x-queryable":false
        },
        "AutoLogSource":{
            "title":"Source System",
            "maxLength":"30",
            "type":"string",
            "description":"For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadIdAttr":{
            "type":"integer",
            "description":"The internal attribute for the lead Id.",
            "nullable":true,
            "x-queryable":true
        },
        "SwitchCallId":{
            "title":"Switch Call ID",
            "maxLength":"128",
            "type":"string",
            "description":"The unique identifier of the call on the external phone system.",
            "nullable":true,
            "x-queryable":false
        },
        "AppointmentStatus":{
            "title":"Appointment Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the appointment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique internal identifier of the conflict",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactIDAttr":{
            "type":"integer",
            "description":"The internal contact identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "type":"string",
            "description":"The code of the object to which activity will get related to.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "type":"string",
            "description":"The campaign number of the campaign associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "CallReportUpcomingYN":{
            "type":"string",
            "description":"Indicates Y,N,M for upcoming appointments.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactName":{
            "title":"Primary Contact",
            "type":"string",
            "description":"The name of the primary contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RecurEndDate":{
            "title":"Ends",
            "type":"string",
            "description":"Ends on a specified date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecurMonFlag":{
            "title":"Monday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Repeat on Monday.",
            "nullable":true,
            "x-queryable":false
        },
        "OpportunityNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"The opportunity number of the opportunity associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "type":"integer",
            "description":"The call report submitter.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"The lead number of lead associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityUpdateDate":{
            "title":"Activity Updated Date",
            "type":"string",
            "description":"The date when the activity was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarSubject":{
            "type":"string",
            "description":"The activity subject.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The name of the account associated to activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ActivityStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerProgramNumber":{
            "title":"Program Number",
            "type":"string",
            "description":"The partner program number of partner program associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The primary contact of the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The priority of the activity. Default to 2. Possible values: 1, 2, 3.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Deal Registration",
            "type":"string",
            "description":"The deal number associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EndDtRFAttr":{
            "type":"string",
            "description":"The internal attribute for activity start date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalContactEmail":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of an external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicClaimLOVSwitcher":{
            "type":"string",
            "description":"The unique identifier of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DismissAssignee":{
            "title":"Dismissed",
            "type":"string",
            "description":"Indicates whether the assignees is dismissed. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityIdAttr":{
            "type":"integer",
            "description":"The internal attribute for the opportunity Id.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityCreatedBy":{
            "title":"Activity Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The activity user who created the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The primary resource on the activity. Supports resources only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityFunctionCodeTrans":{
            "title":"Activity",
            "maxLength":"255",
            "type":"string",
            "description":"The activity function code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrentSystemDtTransient":{
            "type":"string",
            "description":"The current system date,",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "type":"string",
            "description":"The alternate identifier of the case.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CaseId"
                ]
            },
            "x-queryable":true
        },
        "RecurWedFlag":{
            "title":"Wednesday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Repeat on Wednesday.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDateForCallReport":{
            "type":"string",
            "description":"The start date of the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateDuration":{
            "title":"Template Duration",
            "type":"number",
            "description":"The duration in days of the template activity. This attribute is used with the start date when generating an activity from a template to calculate the due date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "RecurSatFlag":{
            "title":"Saturday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Repeat on Saturday.",
            "nullable":true,
            "x-queryable":false
        },
        "ClaimNumber":{
            "title":"Claim Number",
            "type":"string",
            "description":"The number of the claim associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier to identify the orchestration step.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DismissFlag":{
            "title":"Dismissed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this activity is dismissed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The location or address ID of the activity account or primary contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecurThuFlag":{
            "title":"Thursday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Repeat on Thursday.",
            "nullable":true,
            "x-queryable":false
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ArticleVersionId":{
            "title":"Article Version ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the article version.",
            "nullable":true,
            "x-queryable":true
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the fund request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrigEntityNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The column to store the original user key of the object being upgraded to Activity.",
            "nullable":true,
            "x-queryable":false
        },
        "LoginUserRFAttr":{
            "type":"integer",
            "description":"The internal attribute for activity login user.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerProgramName":{
            "title":"Program",
            "type":"string",
            "description":"The name of partner program associated to the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerProgramId"
                ]
            }
        },
        "RecurTypeCode":{
            "title":"Recurrence Type",
            "maxLength":"30",
            "type":"string",
            "description":"Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDateForCallReportAttr":{
            "type":"string",
            "description":"The internal attribute for end date of the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OsnActivityId":{
            "type":"integer",
            "description":"The unique activity identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecurExceptionFlag":{
            "title":"Recurrence Exception",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if appointment instance has been updated outside of recurring appointment series.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "default":"ZMM_ACTY_ACTIVITIES",
            "x-queryable":false
        },
        "CallReportYN":{
            "type":"string",
            "description":"Flag to Check if this activity has a Call Report",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityLastUpdateLogin":{
            "title":"Activity Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"Original Activity Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFormattedAddress":{
            "title":"Primary Contact Address",
            "type":"string",
            "description":"The address of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the activity is private.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ActivityDirection":{
            "type":"string",
            "description":"The direction of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DirectionCode"
                ]
            }
        },
        "WebConferenceURL":{
            "title":"Web Conference URL",
            "maxLength":"2000",
            "type":"string",
            "description":"The web conference join URL.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutLatitude":{
            "title":"Check-Out Latitude",
            "type":"number",
            "description":"Stores the latitude of a location where a user checks out of an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "type":"string",
            "description":"The alternate identifier of the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountAddress":{
            "title":"Account Address",
            "type":"string",
            "description":"The address associated with the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountStatus":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessPlanName":{
            "title":"Business Plan",
            "type":"string",
            "description":"The business plan name associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the activity.",
            "nullable":false,
            "x-queryable":true
        },
        "FundRequestName":{
            "title":"MDF Request",
            "type":"string",
            "description":"The fund request name associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CurrentDateForCallReport":{
            "type":"string",
            "description":"The current date for the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CheckinLongitude":{
            "title":"Check-In Longitude",
            "type":"number",
            "description":"Stores the longitude of a location where a user checks in to an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurOrigInstDate":{
            "title":"Original Instance Date",
            "type":"string",
            "description":"Original date of a recurring appointment instance.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecurSunFlag":{
            "title":"Sunday",
            "maxLength":"1",
            "type":"boolean",
            "description":"Repeat on Sunday.",
            "nullable":true,
            "x-queryable":false
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":"1",
            "type":"boolean",
            "description":"Designates that an appointment is the entire day.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code from profile.",
            "nullable":true,
            "x-queryable":false
        },
        "OrigEntityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The column to store the source of activity record during upgrade.",
            "nullable":true,
            "default":"ACTIVITY",
            "x-queryable":false
        },
        "ApptEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the activity ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalContactName":{
            "title":"External Contact Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of an external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailSentDate":{
            "type":"string",
            "description":"This field is used to capture the Activity Email Notification shared date for Outlook integration.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimName":{
            "title":"MDF Claim",
            "type":"string",
            "description":"The name associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AccountPhoneNumber":{
            "title":"Account Phone Number",
            "type":"string",
            "description":"The phone number associated with the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of the assessment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalendarTimeType":{
            "type":"string",
            "description":"Indicates all day appointment. (Internal Usage)",
            "nullable":true,
            "x-queryable":true
        },
        "RecurMonth":{
            "title":"Month",
            "maxLength":"30",
            "type":"string",
            "description":"Repeat on specified month (for yearly appointments).",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NotesLinkSourceCodeTransient":{
            "type":"string",
            "description":"The note source object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityTimezone":{
            "type":"string",
            "description":"Represents the time zone that the activity needs to be created in, other than the default logged in user's timezone preference.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of primary resource of activity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpgSourceObjectId":{
            "maxLength":"64",
            "type":"string",
            "description":"The primary key value of the record in the source table that is upgraded to Rel9 Activity record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Description",
            "type":"string",
            "description":"A text field for capturing some descriptive information about the activity.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ActivityEO.ActivityDesc",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "RecurDay":{
            "title":"Day",
            "type":"integer",
            "description":"Repeat on specified day of month for monthly appointments.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ActivityStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityUpdatedBy":{
            "title":"Activity Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignName":{
            "title":"Campaign",
            "type":"string",
            "description":"The name of the campaign associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CampaignId"
                ]
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "type":"string",
            "description":"The business plan number of the business plan associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowTimeAs":{
            "title":"Show Time As",
            "type":"string",
            "description":"The show time of the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccountIdAttr":{
            "type":"integer",
            "description":"The internal attribute for the account Id.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "type":"boolean",
            "description":"Flag to indicate if primary Contact can be called.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date the task activity is due to be completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityPartialDescription":{
            "title":"Short Description",
            "maxLength":"4000",
            "type":"string",
            "description":"A column that stores the first 4000 characters of activity description.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentActivityId":{
            "title":"Parent ID",
            "type":"integer",
            "description":"The related activity identifier, only applicable if the record is a follow up activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SearchDate":{
            "type":"string",
            "description":"The date filter used in search (Internal Usage).",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityType":{
            "title":"Activity Type",
            "type":"string",
            "description":"The type of the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ActivityTypeCode"
                ]
            }
        },
        "AccountType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DirectionCode":{
            "title":"Direction",
            "maxLength":"30",
            "type":"string",
            "description":"The inbound or outbound. It's optional. The default is null.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TemplateLeadTime":{
            "title":"Lead Time",
            "type":"number",
            "description":"The lead time in days of the template activity. This attribute is used with the date input parameter when generating an activity from a template to calculate the activity start date. Activity start date is equal date provided as input parameter and lead time.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "CalendarAccess":{
            "type":"boolean",
            "description":"The access rights to calendar. (Internal Usage)",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarRecurType":{
            "type":"string",
            "description":"The activity recurrence type.",
            "nullable":true,
            "x-queryable":true
        },
        "SelectedFlag":{
            "type":"boolean",
            "description":"The records selected for Mass Update (Internal Usage).",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UpgSourceObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityFilter":{
            "type":"string",
            "description":"An internal attribute to add additional activity filter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier for the Business Unit. This attribute is obsolete.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LeadNameOsn":{
            "title":"Social Lead Name",
            "type":"string",
            "description":"The lead name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LeadName"
                ]
            }
        }
    }
}

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

Nested Schema : hrHelpDeskRequests-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• AttachmentsDFFVL: array AttachmentsDFFVL
• AttachmentsPreview: array Attachments Preview
  Title: Attachments Preview

  The attachments preview resource is used to preview the attachment pages.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AttachmentsDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-Attachment-AttachmentsDFFVL-item-response"
            },
            "x-cardinality":"1"
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "AttachmentsPreview":{
            "title":"Attachments Preview",
            "type":"array",
            "description":"The attachments preview resource is used to preview the attachment pages.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-Attachment-AttachmentsPreview-item-response"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : AttachmentsDFFVL

Type: array

Show Source

• Array of: object hrHelpDeskRequests-Attachment-AttachmentsDFFVL-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-Attachment-AttachmentsDFFVL-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Attachments Preview

Type: array

Title: Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Show Source

• Array of: object hrHelpDeskRequests-Attachment-AttachmentsPreview-item-response

{
    "title":"Attachments Preview",
    "type":"array",
    "description":"The attachments preview resource is used to preview the attachment pages.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-Attachment-AttachmentsPreview-item-response"
    }
}

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 : hrHelpDeskRequests-Attachment-AttachmentsDFFVL-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• AttachedDocumentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-Attachment-AttachmentsPreview-item-response

Type: object

Show Source

• ImageHeight: integer
  Title: Image Height

  Read Only: true

  The height of the previewed image.
• ImageSource: string
  Title: Image Source

  Read Only: true

  The preview of the image in base64 encoded PNG format.
• ImageWidth: integer
  Title: Image Width

  Read Only: true

  The width of the previewed image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageNum: integer
  Title: Page Number

  Read Only: true

  The number of the page in the preview.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageSource":{
            "title":"Image Source",
            "type":"string",
            "description":"The preview of the image in base64 encoded PNG format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "PageNum":{
            "title":"Page Number",
            "type":"integer",
            "description":"The number of the page in the preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImageHeight":{
            "title":"Image Height",
            "type":"integer",
            "description":"The height of the previewed image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImageWidth":{
            "title":"Image Width",
            "type":"integer",
            "description":"The width of the previewed image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : hrHelpDeskRequests-channelCommunication-item-response

Type: object

Show Source

• ChannelAccountName: string
  Title: Account Name

  Read Only: true

  Maximum Length: 400

  The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.
• ChannelDisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the channel.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel.
• ChannelShortName: string
  Title: Channel Short Name

  Maximum Length: 450

  The public unique identifier of the channel.
• ChannelTypeCd: string
  Title: Channel Type

  Read Only: true

  Maximum Length: 30

  The code indicating the channel type. For example, email or phone. A list of accepted values are defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
• CollabId: string
  Title: Collaboration ID

  Read Only: true

  Maximum Length: 255

  The unique identifier of the collaboration network user in the corresponding network, such as Slack Id.
• CollabName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 400

  The user name of the external user on the collaboration network.
• CollabResourceId: integer (int64)
  Title: Collaboration Resource Identifier

  The unique identifier of the collaboration network user that the internal users are communicating with.
• ContactPointId: integer (int64)
  Title: Contact Point ID

  The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the communication channel.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the communication channel was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the channel communication has been deleted.
• InboundObjectId: integer (int64)
  Title: Inbound Message Object Identifier

  The unique identifier of the inbound object that resulted in the creation of the service request.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication channel was last updated.
• LastUpdatedBy: string
  Title: Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication channel.
• LastUpdateLogin: string
  Title: Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the communication channel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NetworkTypeCd: string
  Title: Network

  Read Only: true

  Maximum Length: 30

  The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.
• ObjectTypeCd: string
  Title: Object Type

  Read Only: true

  Maximum Length: 30

  Default Value: SVC_SERVICE_REQUESTS

  The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the person who's being communicated with.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The party name of the person who's being communicated with.
• PartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the contact associated with the service request communication.
• PartyViaEndPoint: string
  Title: Party Endpoint

  Maximum Length: 1000

  The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.
• PersonId: integer (int64)
  Title: Person ID

  The unique person ID of the contact.
• PostIdentifier: string
  Title: Post Identifier

  Maximum Length: 1000

  The unique identifier of the social media post record that was used to create the service request or the service request message.
• ResourceId: integer (int64)
  Title: Resource ID

  Read Only: true

  The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.
• ResourceTypeCd: string
  Title: Resource Type

  Read Only: true

  Maximum Length: 30

  The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.
• RoutingCd: string
  Title: Routing Code

  Maximum Length: 30

  The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the channel communication has been updated.
• ViaId: integer (int64)
  Title: ID

  Read Only: true

  The unique identifier of the service request channel communication record.

{
    "type":"object",
    "properties":{
        "ChannelAccountName":{
            "title":"Account Name",
            "maxLength":"400",
            "type":"string",
            "description":"The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the communication channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ViaId":{
            "title":"ID",
            "type":"integer",
            "description":"The unique identifier of the service request channel communication record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the collaboration network user in the corresponding network, such as Slack Id.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the person who's being communicated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollabName":{
            "title":"Resource Name",
            "maxLength":"400",
            "type":"string",
            "description":"The user name of the external user on the collaboration network.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the channel communication has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RoutingCd":{
            "title":"Routing Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "default":"SVC_SERVICE_REQUESTS",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the channel communication has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PostIdentifier":{
            "title":"Post Identifier",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the social media post record that was used to create the service request or the service request message.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyViaEndPoint":{
            "title":"Party Endpoint",
            "maxLength":"1000",
            "type":"string",
            "description":"The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ChannelViaEO.PartyViaEndPoint",
                "protectionObjectTitle":"Party Endpoint",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Party Endpoint"
            },
            "x-queryable":true
        },
        "InboundObjectId":{
            "title":"Inbound Message Object Identifier",
            "type":"integer",
            "description":"The unique identifier of the inbound object that resulted in the creation of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request communication.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the person who's being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollabResourceId":{
            "title":"Collaboration Resource Identifier",
            "type":"integer",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelShortName":{
            "title":"Channel Short Name",
            "maxLength":"450",
            "type":"string",
            "description":"The public unique identifier of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the channel type. For example, email or phone. A list of accepted values are defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the communication channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-contacts-item-response

Type: object

Show Source

• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

  The access level granted to the service request contact.
• AccountName: string
  Title: Account Name

  Read Only: true

  Maximum Length: 900

  The primary account of the service request contact.
• ContactEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the contact.
• ContactFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the contact.
• ContactPartyName: string
  Title: Name

  Maximum Length: 360

  The name of a service request contact.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the contact identifier.
• ContactPreferredContactMethod: string
  Title: Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred contact method of the contact.
• ContactTypeCd: string
  Title: Contact Type

  Maximum Length: 30

  The service request contact type such as Customer or Partner.
• ContactUniqueName: string
  Title: Unique Name

  Maximum Length: 900

  The unique party name of the contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the contact as a member of the service request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the user has access to delete the record.
• DoNotContactFlag: boolean
  Title: Do Not Contact

  Read Only: true

  Maximum Length: 1

  Indicates whether the contact of the service request doesn't want to be contacted.
• FormattedAddress: string
  Title: Formatted Address

  Read Only: true

  Indicates the formatted address of the service request contact.
• JobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

  The job title of the service request contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service request contact member record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last update the contact's object associated with the service request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberId: integer (int64)
  Title: Member ID

  The unique identifier of the contact.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the contact.
• PersonId: integer (int64)
  Title: Person ID

  The unique person ID of the contact.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False.
• RelationTypeCd: string
  Title: Relationship Type Code

  Maximum Length: 30

  The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the associated service request.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The alternative key for the service request number.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique party name of the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":"30",
            "type":"string",
            "description":"The access level granted to the service request contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred contact method of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the associated service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the service request contact member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ContactPersonalPhoneFlag",
                    "ContactPrimaryPhoneAreaCode",
                    "ContactPrimaryPhoneContactPtId",
                    "ContactPrimaryPhoneCountryCode",
                    "ContactPrimaryPhoneExtension",
                    "ContactPrimaryPhoneLineType",
                    "ContactPrimaryPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who added the contact as a member of the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "type":"string",
            "description":"Indicates the formatted address of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContactIdenAddrLocationId"
                ]
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the contact identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the contact of the service request doesn't want to be contacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactTypeCd":{
            "title":"Contact Type",
            "maxLength":"30",
            "type":"string",
            "description":"The service request contact type such as Customer or Partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record 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 update the contact's object associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":"900",
            "type":"string",
            "description":"The primary account of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-messages-item-response

Type: object

Show Source

• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• channelCommunication: array Service Request Message Communications
  Title: Service Request Message Communications

  The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
• ChannelId: string
  Title: Channel

  The unique identifier of the channel.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The channel type, such a email, phone, social, and so on.
• CollabResource: string
  Title: Collaboration Resource

  The unique identifier of the collaboration network user that the internal users are communicating with.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the message.
• CreatedByEmailAddress: string
  Title: Created by Email ID

  Read Only: true

  Maximum Length: 320

  The email Id of the person who created the service request message.
• CreatedByPartyId: string
  Title: Created by Party ID

  Read Only: true

  Maximum Length: 80

  The unique party identifier of the person who created the service request message.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the message was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the user has access to delete the record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the message was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the message.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageContent: string (byte)
  Title: Message Content

  The content of the service request message.
• MessageCreatedBy: string
  Title: Created By

  Maximum Length: 64

  The user who created the message in the original source system. This is applicable if the service request message was imported from another system.
• MessageExpandingState: integer
  Title: Message Expand State

  The message expanding state.
• MessageId: integer (int64)
  Title: Message ID

  The unique identifier of the service request message.
• MessageLastUpdateDate: string (date-time)
  Title: Last Updated Date

  The date when the message was last updated in the original source system. This is applicable if the service request message was imported from another system.
• MessageLastUpdatedBy: string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the message in the original source system. This is applicable if the service request message was imported from another system.
• MessageLastUpdateLogin: string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the message in the original source system. This is applicable if the service request message was imported from another system.
• MessageNumber: string
  Title: Message Number

  Maximum Length: 30

  The public unique identifier of the service request message.
• MessageSubTypeCd: string
  Title: Message Subtype

  Maximum Length: 30

  The service request message subtype.
• MessageTypeCd: string
  Title: Message Type Code

  Maximum Length: 30

  The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.
• NetworkTypeCd: string
  Title: Network

  Read Only: true

  Maximum Length: 30

  The type of social network.
• NotificationProcessingStatusCd: string
  Title: Notification Processing Status Code

  Maximum Length: 30

  The notification processing status code.
• NotificationRetryCount: integer (int32)
  Title: Notification Retry Count

  The notification retry count.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object.
• ObjectTypeCd: string
  Title: Object Type Code

  Maximum Length: 30

  Default Value: SVC_SR_MESSAGES

  The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The unique identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system.
• OriginationDate: string (date-time)
  Title: Origination Date

  The date the message was created in the original source system. This is applicable if the service request message was imported from another system.
• ParentMessageId: integer (int64)
  Title: Parent Message ID

  The unique identifier of the parent message.
• PartyName: string
  Title: Posted By

  Read Only: true

  Maximum Length: 360

  The party name of the user who posted the message. The user can be an internal resource or a customer contact.
• PostedByPartyId: integer (int64)
  Title: Posted by ID

  The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact.
• PostedByPartyNumber: string
  Title: Posted by Party Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the party identifier of the person posting the service request message.
• PrivateInformationFlag: boolean
  Title: Contains PII Data

  Maximum Length: 1

  Indicates whether the message contains personally identifiable information.
• ProcessingId: integer (int64)
  Title: Processing ID

  Read Only: true

  The unique identifier of the processing.
• ProcessingStatusCd: string
  Title: Processing Status

  Maximum Length: 30

  Default Value: ORA_SVC_READY

  The processing status of the message. The accepted values are Ready, Processing, Error, and Success.
• ReplyToMessageId: integer (int64)
  Title: Reply to Message ID

  Read Only: true

  The unique identifier of the customer message to which the agent is replying to.
• RichTextFlag: boolean
  Title: Rich Text

  Maximum Length: 1

  Default Value: true

  Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N.
• RootMessageId: integer (int64)
  Title: Root Message Identifier

  Read Only: true

  The identifier of the root message in the message hierarchy.
• RootThreadCount: integer
  Title: Root Message Thread Count

  Read Only: true

  The number of messages under a root message in a service request.
• RootThreadLastUpdateDate: string (date-time)
  Title: Root Message Thread Last Updated Date

  Read Only: true

  The last updated date for all messages under the root message in a service request.
• RootThreadMessageLastUpdateDate: string (date-time)
  Title: Root Thread Message Last Updated Date

  Read Only: true

  The date when all messages under the root message in a service request were last updated.
• SentDate: string (date-time)
  Title: Sent Date

  The date and time when the message was sent.
• SocialPrivateFlag: boolean
  Title: Private Message

  Maximum Length: 1

  Indicates whether the service request was created from a private social post.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  The source of the message.
• SrBUOrgId: integer (int64)
  Title: Service Request Business Unit

  Read Only: true

  The identifier of the business unit associated with the service request.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request to which the message is associated.
• SrInlineAttachmentIds: string
  Title: Inline Attachment Identifiers

  Maximum Length: 1000

  The list of inline attachment identifiers associated with the service request
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The alternative key for the service request number.
• SrStripeCd: string
  Title: Service Request Application Stripe

  Read Only: true

  Maximum Length: 30

  The application stripe of the service request.
• StatusCd: string
  Title: Status Code

  Maximum Length: 30

  The status of the message. The accepted values are Draft, Committed, and Corrected.
• Subject: string
  Title: Subject

  Maximum Length: 1000

  The subject of the service request message.
• TemplateName: string
  Title: Template Name

  Maximum Length: 240

  The name of the template that's used for outbound communication of the message.
• ThreadCount: integer
  Title: Thread Count

  Read Only: true

  The number of threads in a service request message.
• ThreadHierarchyLevel: integer
  Title: Thread Hierarchy Level

  Read Only: true

  The thread hierarchy level.
• ThreadId: integer
  Title: Thread Identifier

  Read Only: true

  The unique identifier of the service request message thread.
• ThreadLastUpdateDate: string (date-time)
  Title: Thread Last Updated Date

  Read Only: true

  The date when the thread was last updated.
• ThreadMessageLastUpdateDate: string (date-time)
  Title: Thread Message Last Updated Date

  Read Only: true

  The date when the thread message was last updated.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record.
• VisibilityCd: string
  Title: Visibility Code

  Maximum Length: 30

  The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageContent":{
            "title":"Message Content",
            "type":"string",
            "description":"The content of the service request message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"SrMessageEO.MessageContent",
                "protectionObjectTitle":"Message Content",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Message Content"
            }
        },
        "ThreadMessageLastUpdateDate":{
            "title":"Thread Message Last Updated Date",
            "type":"string",
            "description":"The date when the thread message was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NotificationProcessingStatusCd":{
            "title":"Notification Processing Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The notification processing status code.",
            "nullable":true,
            "x-queryable":true
        },
        "PrivateInformationFlag":{
            "title":"Contains PII Data",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the message contains personally identifiable information.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingId":{
            "title":"Processing ID",
            "type":"integer",
            "description":"The unique identifier of the processing.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date and time when the message was sent.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Posted By",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the user who posted the message. The user can be an internal resource or a customer contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageLastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the message was last updated in the original source system. This is applicable if the service request message was imported from another system.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-messages-Attachment-item-response"
            }
        },
        "MessageExpandingState":{
            "title":"Message Expand State",
            "type":"integer",
            "description":"The message expanding state.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplyToMessageId":{
            "title":"Reply to Message ID",
            "type":"integer",
            "description":"The unique identifier of the customer message to which the agent is replying to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The source of the message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CollabResource":{
            "title":"Collaboration Resource",
            "type":"string",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ThreadHierarchyLevel":{
            "title":"Thread Hierarchy Level",
            "type":"integer",
            "description":"The thread hierarchy level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrStripeCd":{
            "title":"Service Request Application Stripe",
            "maxLength":"30",
            "type":"string",
            "description":"The application stripe of the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatusCd":{
            "title":"Processing Status",
            "maxLength":"30",
            "type":"string",
            "description":"The processing status of the message. The accepted values are Ready, Processing, Error, and Success.",
            "nullable":true,
            "default":"ORA_SVC_READY",
            "x-queryable":true
        },
        "MessageLastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the message in the original source system. This is applicable if the service request message was imported from another system.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdatedBy"
                ]
            },
            "x-queryable":true
        },
        "CreatedByPartyId":{
            "title":"Created by Party ID",
            "maxLength":"80",
            "type":"string",
            "description":"The unique party identifier of the person who created the service request message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.",
            "nullable":false,
            "default":"SVC_SR_MESSAGES",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RootThreadMessageLastUpdateDate":{
            "title":"Root Thread Message Last Updated Date",
            "type":"string",
            "description":"The date when all messages under the root message in a service request were last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostedByPartyId":{
            "title":"Posted by ID",
            "type":"integer",
            "description":"The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RootMessageId":{
            "title":"Root Message Identifier",
            "type":"integer",
            "description":"The identifier of the root message in the message hierarchy.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NotificationRetryCount":{
            "title":"Notification Retry Count",
            "type":"integer",
            "description":"The notification retry count.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "OriginationDate":{
            "title":"Origination Date",
            "type":"string",
            "description":"The date the message was created in the original source system. This is applicable if the service request message was imported from another system.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CreationDate"
                ]
            },
            "x-queryable":true
        },
        "RichTextFlag":{
            "title":"Rich Text",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The channel type, such a email, phone, social, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootThreadLastUpdateDate":{
            "title":"Root Message Thread Last Updated Date",
            "type":"string",
            "description":"The last updated date for all messages under the root message in a service request.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":"30",
            "type":"string",
            "description":"The type of social network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the service request message.",
            "nullable":false,
            "x-queryable":true
        },
        "SrBUOrgId":{
            "title":"Service Request Business Unit",
            "type":"integer",
            "description":"The identifier of the business unit associated with the service request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VisibilityCd":{
            "title":"Visibility Code",
            "maxLength":"30",
            "type":"string",
            "description":"The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageTypeCd":{
            "title":"Message Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel",
            "type":"string",
            "description":"The unique identifier of the channel.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ChannelTypeCd"
                ]
            }
        },
        "ThreadLastUpdateDate":{
            "title":"Thread Last Updated Date",
            "type":"string",
            "description":"The date when the thread was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ThreadId":{
            "title":"Thread Identifier",
            "type":"integer",
            "description":"The unique identifier of the service request message thread.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageSubTypeCd":{
            "title":"Message Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"The service request message subtype.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Template Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the template that's used for outbound communication of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "channelCommunication":{
            "title":"Service Request Message Communications",
            "type":"array",
            "description":"The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-messages-channelCommunication-item-response"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request to which the message is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SocialPrivateFlag":{
            "title":"Private Message",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the service request was created from a private social post.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the message. The accepted values are Draft, Committed, and Corrected.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentMessageId":{
            "title":"Parent Message ID",
            "type":"integer",
            "description":"The unique identifier of the parent message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":"1000",
            "type":"string",
            "description":"The subject of the service request message.",
            "nullable":true,
            "x-queryable":true
        },
        "PostedByPartyNumber":{
            "title":"Posted by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the party identifier of the person posting the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the message in the original source system. This is applicable if the service request message was imported from another system.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            },
            "x-queryable":true
        },
        "CreatedByEmailAddress":{
            "title":"Created by Email ID",
            "maxLength":"320",
            "type":"string",
            "description":"The email Id of the person who created the service request message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThreadCount":{
            "title":"Thread Count",
            "type":"integer",
            "description":"The number of threads in a service request message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageLastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the message in the original source system. This is applicable if the service request message was imported from another system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LastUpdateLogin"
                ]
            },
            "x-queryable":true
        },
        "RootThreadCount":{
            "title":"Root Message Thread Count",
            "type":"integer",
            "description":"The number of messages under a root message in a service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the service request message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrInlineAttachmentIds":{
            "title":"Inline Attachment Identifiers",
            "maxLength":"1000",
            "type":"string",
            "description":"The list of inline attachment identifiers associated with the service request",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object hrHelpDeskRequests-messages-Attachment-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-messages-Attachment-item-response"
    }
}

Nested Schema : Service Request Message Communications

Type: array

Title: Service Request Message Communications

The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Show Source

• Array of: object hrHelpDeskRequests-messages-channelCommunication-item-response

{
    "title":"Service Request Message Communications",
    "type":"array",
    "description":"The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-messages-channelCommunication-item-response"
    }
}

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 : hrHelpDeskRequests-messages-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• AttachmentsDFFVL: array AttachmentsDFFVL
• AttachmentsPreview: array Attachments Preview
  Title: Attachments Preview

  The attachments preview resource is used to preview the attachment pages.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AttachmentsDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-messages-Attachment-AttachmentsDFFVL-item-response"
            },
            "x-cardinality":"1"
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "AttachmentsPreview":{
            "title":"Attachments Preview",
            "type":"array",
            "description":"The attachments preview resource is used to preview the attachment pages.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-messages-Attachment-AttachmentsPreview-item-response"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : AttachmentsDFFVL

Type: array

Show Source

• Array of: object hrHelpDeskRequests-messages-Attachment-AttachmentsDFFVL-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-messages-Attachment-AttachmentsDFFVL-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Attachments Preview

Type: array

Title: Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Show Source

• Array of: object hrHelpDeskRequests-messages-Attachment-AttachmentsPreview-item-response

{
    "title":"Attachments Preview",
    "type":"array",
    "description":"The attachments preview resource is used to preview the attachment pages.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-messages-Attachment-AttachmentsPreview-item-response"
    }
}

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 : hrHelpDeskRequests-messages-Attachment-AttachmentsDFFVL-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• AttachedDocumentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-messages-Attachment-AttachmentsPreview-item-response

Type: object

Show Source

• ImageHeight: integer
  Title: Image Height

  Read Only: true

  The height of the previewed image.
• ImageSource: string
  Title: Image Source

  Read Only: true

  The preview of the image in base64 encoded PNG format.
• ImageWidth: integer
  Title: Image Width

  Read Only: true

  The width of the previewed image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageNum: integer
  Title: Page Number

  Read Only: true

  The number of the page in the preview.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageSource":{
            "title":"Image Source",
            "type":"string",
            "description":"The preview of the image in base64 encoded PNG format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "PageNum":{
            "title":"Page Number",
            "type":"integer",
            "description":"The number of the page in the preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImageHeight":{
            "title":"Image Height",
            "type":"integer",
            "description":"The height of the previewed image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImageWidth":{
            "title":"Image Width",
            "type":"integer",
            "description":"The width of the previewed image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : hrHelpDeskRequests-messages-channelCommunication-item-response

Type: object

Show Source

• ChannelAccountName: string
  Title: Account Name

  Read Only: true

  Maximum Length: 400

  The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.
• ChannelDisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the channel.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel.
• ChannelShortName: string
  Title: Channel Short Name

  Maximum Length: 450

  The public unique identifier of the channel.
• ChannelTypeCd: string
  Title: Channel Type

  Read Only: true

  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.
• CollabId: string
  Title: Collaboration ID

  Read Only: true

  Maximum Length: 255

  The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id of a user.
• CollabName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 400

  The user name of the external user on the collaboration network.
• CollabResourceId: integer (int64)
  Title: Collaboration Resource Identifier

  The unique identifier of the collaboration network user that the internal users are communicating with.
• ContactPointId: integer (int64)
  Title: Contact Point ID

  The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address while the contact point of a person for twitter would be the twitter handle.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the communication channel.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the communication channel was created.
• InboundObjectId: integer (int64)
  Title: Inbound Message Object Identifier

  The unique identifier of the inbound object that resulted in the creation of the service request.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication channel was last updated.
• LastUpdatedBy: string
  Title: Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication channel.
• LastUpdateLogin: string
  Title: Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the communication channel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageNumber: string
  Title: Message Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the service request message.
• NetworkTypeCd: string
  Title: Network

  Read Only: true

  Maximum Length: 30

  The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.
• ObjectTypeCd: string
  Title: Object Type

  Read Only: true

  Maximum Length: 30

  Default Value: SVC_SR_MESSAGES

  The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the person who's being communicated with.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The party name of the person who's being communicated with.
• PartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the contact associated with the service request message.
• PartyViaEndPoint: string
  Title: Party Endpoint

  Maximum Length: 1000

  The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.
• PersonId: integer (int64)
  Title: Person ID

  The unique person ID of the contact.
• PostIdentifier: string
  Title: Post Identifier

  Maximum Length: 1000

  The unique identifier of the social media post record that was used to create the service request or the service request message.
• ResourceId: integer (int64)
  Title: Resource ID

  Read Only: true

  The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.
• ResourceTypeCd: string
  Title: Resource Type

  Read Only: true

  Maximum Length: 30

  The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.
• RoutingCd: string
  Title: Routing Code

  Maximum Length: 30

  The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.
• ViaId: integer (int64)
  Title: ID

  Read Only: true

  The unique identifier of the service request channel communication record.

{
    "type":"object",
    "properties":{
        "ChannelAccountName":{
            "title":"Account Name",
            "maxLength":"400",
            "type":"string",
            "description":"The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the communication channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViaId":{
            "title":"ID",
            "type":"integer",
            "description":"The unique identifier of the service request channel communication record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id of a user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the person who's being communicated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollabName":{
            "title":"Resource Name",
            "maxLength":"400",
            "type":"string",
            "description":"The user name of the external user on the collaboration network.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoutingCd":{
            "title":"Routing Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address while the contact point of a person for twitter would be the twitter handle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "default":"SVC_SR_MESSAGES",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PostIdentifier":{
            "title":"Post Identifier",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the social media post record that was used to create the service request or the service request message.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyViaEndPoint":{
            "title":"Party Endpoint",
            "maxLength":"1000",
            "type":"string",
            "description":"The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ChannelViaEO.PartyViaEndPoint",
                "protectionObjectTitle":"Party Endpoint",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Party Endpoint"
            },
            "x-queryable":true
        },
        "InboundObjectId":{
            "title":"Inbound Message Object Identifier",
            "type":"integer",
            "description":"The unique identifier of the inbound object that resulted in the creation of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the person who's being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollabResourceId":{
            "title":"Collaboration Resource Identifier",
            "type":"integer",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelShortName":{
            "title":"Channel Short Name",
            "maxLength":"450",
            "type":"string",
            "description":"The public unique identifier of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the communication channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-resourceMembers-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the service request resource member.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the service request resource member was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the user has access to delete the record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the service request resource member record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service request resource member record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the service request resource member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberId: integer (int64)
  Title: Member ID

  A unique identifier of the service request resource member.
• ObjectId: integer (int64)
  Title: Service Request Team Member Resource ID

  The unique identifier of the service request resource member.
• ObjectTypeCd: string
  Title: Object Type

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_RESOURCE

  Indicates whether the resource is an individual or a team.
• OwnerFlag: boolean
  Title: Assigned To

  Indicates whether the service request is assigned to the resource member. If yes, the value is True, else the value is False.
• PartyUniqueName: string
  Title: Unique Party Name

  Read Only: true

  Maximum Length: 900

  The unique name of the service request resource member.
• ResourceEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the resource member.
• ResourceFormattedAddress: string
  Title: Resource Formatted Address

  Read Only: true

  The formatted address of the SR resource member.
• ResourceFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the resource member.
• ResourceName: string
  Title: Name

  Maximum Length: 360

  The name of the service request resource member.
• ResourcePartyNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  The alternative key for the service request resource.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The alternative key for the service request number.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record.
• UserGUID: string
  Title: User GUID

  Read Only: true

  Maximum Length: 64

  The global unique identifier of the service request resource member.
• UserId: integer (int64)
  Title: User ID

  Read Only: true

  The unique user identifier of the service request resource member.
• Username: string
  Title: User Name

  Read Only: true

  Maximum Length: 100

  The user name of the resource member.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the service request resource member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service request resource member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who added the service request resource member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Service Request Team Member Resource ID",
            "type":"integer",
            "description":"The unique identifier of the service request resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserGUID":{
            "title":"User GUID",
            "maxLength":"64",
            "type":"string",
            "description":"The global unique identifier of the service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the service request resource member.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Assigned To",
            "type":"boolean",
            "description":"Indicates whether the service request is assigned to the resource member. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ObjectId"
                ]
            }
        },
        "PartyUniqueName":{
            "title":"Unique Party Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceFormattedAddress":{
            "title":"Resource Formatted Address",
            "type":"string",
            "description":"The formatted address of the SR resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceCountry",
                    "ResourceIdenAddrLocationId",
                    "ResourcePersonalAddressFlag"
                ]
            }
        },
        "ResourceEmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"A unique identifier of the service request resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Username":{
            "title":"User Name",
            "maxLength":"100",
            "type":"string",
            "description":"The user name of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserId":{
            "title":"User ID",
            "type":"integer",
            "description":"The unique user identifier of the service request resource member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ResourcePersonalPhoneFlag",
                    "ResourcePrimaryPhoneAreaCode",
                    "ResourcePrimaryPhoneContactPtId",
                    "ResourcePrimaryPhoneCountryCode",
                    "ResourcePrimaryPhoneExtension",
                    "ResourcePrimaryPhoneLineType",
                    "ResourcePrimaryPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the resource is an individual or a team.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_RESOURCE",
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the service request resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the service request resource member record 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 service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object hrHelpDeskRequests-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object hrHelpDeskRequests-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object hrHelpDeskRequests-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : hrHelpDeskRequests-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-srInteractionReferences-item-response

Type: object

Show Source

• AccountPartyId: integer (int64)
  Title: Account ID

  Read Only: true

  The unique identifier of the account associated with the interaction.
• AccountPartyUniqueName: string
  Title: Account

  Read Only: true

  Maximum Length: 900

  The account name associated with the interaction.
• ChannelDisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 400

  The display name of the channel that's populated in the interaction.
• ChannelId: integer (int64)
  Title: Channel ID

  Read Only: true

  The unique identifier of the interaction channel.
• ChannelTypeCd: string
  Title: Channel Type

  Read Only: true

  Maximum Length: 30

  The channel type of the interaction.
• ContactPartyId: integer (int64)
  Title: Contact ID

  Read Only: true

  The unique identifier of the contact person with whom the agent is interacting.
• ContactPartyUniqueName: string
  Title: Contact

  Read Only: true

  Maximum Length: 900

  The name of the customer contact for the interaction.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the interaction.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the interaction was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the record can be deleted.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the interaction.
• DirectionCd: string
  Title: Direction

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_INBOUND

  The direction of the interaction.
• EndTime: string (date-time)
  Title: End Time

  Read Only: true

  The time when the interaction ended.
• InteractionId: integer (int64)
  Title: Interaction ID

  Read Only: true

  The unique identifier of the interaction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the interaction was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the interaction.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the interaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalSystemReference: string
  Title: Original System

  Read Only: true

  Maximum Length: 255

  The original system reference for the interaction.
• OwnerResourceId: integer (int64)
  Title: Owner Resource ID

  Read Only: true

  The unique identifier of the agent who owns the interaction.
• OwnerResourcePartyUniqueName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 900

  The resource, which is an internal interaction owner such as a service agent, associated with the interaction.
• ParentInteractionId: integer (int64)
  Title: Parent Interaction ID

  Read Only: true

  The unique identifier of the parent interaction.
• Payload: string (byte)
  Title: Payload

  Read Only: true

  The payload of the interaction.
• QueueId: integer (int64)
  Title: Queue ID

  Read Only: true

  The unique identifier of the interaction queue.
• QueueName: string
  Title: Name

  Read Only: true

  Maximum Length: 400

  The name of the queue in the interaction.
• ReferenceId: integer (int64)
  Title: Reference ID

  Read Only: true

  The unique identifier of the reference relationship.
• StartTime: string (date-time)
  Title: Start Time

  Read Only: true

  The start time of the interaction.
• StatusCd: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_OPEN

  The interaction status.
• StripeCd: string
  Title: Stripe Code

  Read Only: true

  Maximum Length: 30

  The application stripe of the interaction.
• TopLevelFlag: boolean
  Title: Top Level

  Read Only: true

  Indicates whether the interaction is a top level interaction.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the interaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the interaction ended.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":"30",
            "type":"string",
            "description":"The direction of the interaction.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_INBOUND",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The display name of the channel that's populated in the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":"900",
            "type":"string",
            "description":"The account name associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the interaction channel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TopLevelFlag":{
            "title":"Top Level",
            "type":"boolean",
            "description":"Indicates whether the interaction is a top level interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "ExtnMassUpdateable":"false"
            }
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier of the reference relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OwnerResourcePartyUniqueName":{
            "title":"Resource Name",
            "maxLength":"900",
            "type":"string",
            "description":"The resource, which is an internal interaction owner such as a service agent, associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the agent who owns the interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact person with whom the agent is interacting.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QueueName":{
            "title":"Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the queue in the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The interaction status.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_OPEN",
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The original system reference for the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The start time of the interaction.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the interaction queue.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPartyUniqueName":{
            "title":"Contact",
            "maxLength":"900",
            "type":"string",
            "description":"The name of the customer contact for the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "ExtnMassUpdateable":"false"
            }
        },
        "ParentInteractionId":{
            "title":"Parent Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the parent interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The application stripe of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload of the interaction.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The channel type of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the interaction 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 interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-srMilestone-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates whether the service request milestone is active.
• AgentCompletedFlag: boolean
  Title: Agent Completed

  Maximum Length: 1

  Default Value: false

  Indicates whether agent marked the milestone as complete.
• AllowAgentCompletionFlag: boolean
  Title: Allow Agent Completion

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether an agent can mark the milestone as complete.
• AllowDueDateOverrideFlag: boolean
  Title: Allow Due Date Override

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether an agent can override the milestone due date.
• Comments: string
  Title: Comments

  Maximum Length: 400

  The customer or agent comments.
• CompletionDate: string (date-time)
  Title: Completion Date

  The date when the milestone is to be completed.
• ComplianceFlag: boolean
  Title: Compliance

  Maximum Length: 1

  Default Value: true

  The compliance status of the milestone.
• CoverageId: integer (int64)
  Title: Coverage ID

  The unique identifier for the coverage record.
• CoverageSourceCd: string
  Title: Coverage Source

  Maximum Length: 120

  Coverage Source
• CoverageSourceCdMeaning: string
  Title: Coverage Source

  Read Only: true

  The display value corresponding to the coverage source lookup code.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the milestone.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• DelayTime: integer (int64)
  Title: Delay Time

  The time between the due date and the completion date.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the user has access to delete the record.
• DueDate: string (date-time)
  The due date of the milestone.
• EntitlementId: integer
  The unique identifier of the entitlement record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the milestone.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the milestone.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MilestoneConfigId: integer (int64)
  Title: Milestone Configuration ID

  The unique identifier of the milestone configuration record.
• MilestoneLabel: string
  Title: Name

  Read Only: true

  Maximum Length: 255

  The name of the milestone.
• MilestoneStatusCd: string
  Title: Status

  Maximum Length: 30

  The status of the milestone.
• MilestoneStatusCdMeaning: string
  Title: Milestone Status

  Read Only: true

  Maximum Length: 255

  The display value corresponding to the status lookup code for the milestone.
• PauseConditionLabel: string
  Title: Pauses When

  Read Only: true

  Maximum Length: 1000

  The time when the milestone pauses.
• SrAssigneePartyId: integer
  Title: Assigned to Party ID

  The unique party object identifier of the service request assignee.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request record.
• SrMilestoneHistory: array Milestones History
  Title: Milestones History

  The list of changes in the service request milestone status.
• SrMilestoneId: integer (int64)
  Title: Milestone ID

  Read Only: true

  The unique identifier of the service request milestone record.
• StartConditionLabel: string
  Title: Starts When

  Read Only: true

  Maximum Length: 1000

  The time when the milestone starts.
• SubscriptionCoveragePuid: string
  Title: Subscription Coverage PUID

  Maximum Length: 120

  Subscription Coverage PUID
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  Subscription Number
• TimeLeftOnceUnpaused: integer
  Title: Paused Minutes Remaining

  The time left, in minutes, to complete the milestone after it's restored from the paused state.
• TimeRemaining: string
  Title: Time Remaining

  Read Only: true

  The time remaining in the milestone.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record.
• WarnedFlag: boolean
  Title: Warned

  Maximum Length: 1

  Default Value: false

  Indicates whether milestone passed the warning threshold.
• WarningDate: string (date-time)
  Title: Warning Date

  The date and time when the milestone passed the warning threshold.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WarnedFlag":{
            "title":"Warned",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether milestone passed the warning threshold.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "StartConditionLabel":{
            "title":"Starts When",
            "maxLength":"1000",
            "type":"string",
            "description":"The time when the milestone starts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement record.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneStatusCdMeaning":{
            "title":"Milestone Status",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "MilestoneStatusCd"
                ]
            },
            "x-queryable":true
        },
        "TimeLeftOnceUnpaused":{
            "title":"Paused Minutes Remaining",
            "type":"integer",
            "description":"The time left, in minutes, to complete the milestone after it's restored from the paused state.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageSourceCdMeaning":{
            "title":"Coverage Source",
            "type":"string",
            "description":"The display value corresponding to the coverage source lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CoverageSourceCd"
                ]
            },
            "x-queryable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the service request milestone record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowAgentCompletionFlag":{
            "title":"Allow Agent Completion",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an agent can mark the milestone as complete.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier for the coverage record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowDueDateOverrideFlag":{
            "title":"Allow Due Date Override",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an agent can override the milestone due date.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DueDate":{
            "type":"string",
            "description":"The due date of the milestone.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date when the milestone is to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MilestoneLabel":{
            "title":"Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"Subscription Number",
            "nullable":true,
            "x-queryable":true
        },
        "SrAssigneePartyId":{
            "title":"Assigned to Party ID",
            "type":"integer",
            "description":"The unique party object identifier of the service request assignee.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"400",
            "type":"string",
            "description":"The customer or agent comments.",
            "nullable":true,
            "x-queryable":true
        },
        "PauseConditionLabel":{
            "title":"Pauses When",
            "maxLength":"1000",
            "type":"string",
            "description":"The time when the milestone pauses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayTime":{
            "title":"Delay Time",
            "type":"integer",
            "description":"The time between the due date and the completion date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrMilestoneHistory":{
            "title":"Milestones History",
            "type":"array",
            "description":"The list of changes in the service request milestone status.",
            "items":{
                "$ref":"#/components/schemas/hrHelpDeskRequests-srMilestone-SrMilestoneHistory-item-response"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the service request milestone is active.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TimeRemaining":{
            "title":"Time Remaining",
            "type":"string",
            "description":"The time remaining in the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageSourceCd":{
            "title":"Coverage Source",
            "maxLength":"120",
            "type":"string",
            "description":"Coverage Source",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MilestoneConfigId":{
            "title":"Milestone Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the milestone configuration record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WarningDate":{
            "title":"Warning Date",
            "type":"string",
            "description":"The date and time when the milestone passed the warning threshold.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ComplianceFlag":{
            "title":"Compliance",
            "maxLength":"1",
            "type":"boolean",
            "description":"The compliance status of the milestone.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "SubscriptionCoveragePuid":{
            "title":"Subscription Coverage PUID",
            "maxLength":"120",
            "type":"string",
            "description":"Subscription Coverage PUID",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record 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 milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgentCompletedFlag":{
            "title":"Agent Completed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether agent marked the milestone as complete.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        }
    }
}

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 : Milestones History

Type: array

Title: Milestones History

The list of changes in the service request milestone status.

Show Source

• Array of: object hrHelpDeskRequests-srMilestone-SrMilestoneHistory-item-response

{
    "title":"Milestones History",
    "type":"array",
    "description":"The list of changes in the service request milestone status.",
    "items":{
        "$ref":"#/components/schemas/hrHelpDeskRequests-srMilestone-SrMilestoneHistory-item-response"
    }
}

Nested Schema : hrHelpDeskRequests-srMilestone-SrMilestoneHistory-item-response

Type: object

Show Source

• AccumulatedTimeInStatus: integer (int64)
  Title: Accumulated Time

  The total time the service request milestone spent in the status.
• Comments: string
  Title: Description

  Maximum Length: 400

  The comments of the agent.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• EndTime: string (date-time)
  The date and time when the milestone exited the status.
• HistoryId: integer (int64)
  Title: History ID

  Read Only: true

  The unique identifier of the milestone history record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the milestone history.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the milestone history.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MilestoneStatusCd: string
  Title: Status

  Maximum Length: 30

  The status of the milestone.
• OverriddenDueDate: string (date-time)
  Title: Due Date

  The milestone overridden due date.
• SrMilestoneId: integer (int64)
  Title: Milestone ID

  The unique identifier of the service request milestone record.
• StartTime: string (date-time)
  Title: Date

  The date and time when the milestone status was changed.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the milestone history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryId":{
            "title":"History ID",
            "type":"integer",
            "description":"The unique identifier of the milestone history record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"The date and time when the milestone exited the status.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Description",
            "maxLength":"400",
            "type":"string",
            "description":"The comments of the agent.",
            "nullable":true,
            "x-queryable":true
        },
        "AccumulatedTimeInStatus":{
            "title":"Accumulated Time",
            "type":"integer",
            "description":"The total time the service request milestone spent in the status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartTime":{
            "title":"Date",
            "type":"string",
            "description":"The date and time when the milestone status was changed.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the service request milestone record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverriddenDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The milestone overridden due date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record 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 milestone history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-srReferences-item-response

Type: object

Show Source

• ArticleId: string
  Title: Article ID

  Maximum Length: 64

  The unique identifier of the referenced article.
• ArticleLocale: string
  Title: Article Locale

  Maximum Length: 10

  The locale of the knowledge management article.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the reference to the service request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the service request reference was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the user has access to delete the record.
• DocumentId: string
  Title: Document ID

  Read Only: true

  Maximum Length: 50

  The unique document identifier associated with the referenced article.
• HelpfulFlag: boolean
  Title: Helpful

  Maximum Length: 1

  Indicates whether the service request reference was helpful.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service request reference.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login ID of the user who last updated the service request reference.
• LinkedFlag: boolean
  Title: Linked

  Maximum Length: 1

  Indicates whether the reference is linked with the service request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Object ID

  Indicates whether the object is referenced to the service request.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The object type of the reference object.
• ReferenceId: integer (int64)
  Title: Reference ID

  Read Only: true

  The unique identifier of the current reference record.
• RelationTypeCd: string
  Title: Relation Type

  Maximum Length: 30

  The relationship type between the service request and the referenced object.
• ResolutionCd: string
  Title: Resolution Code

  Maximum Length: 30

  Indicates whether the referenced object helps in resolving the service request.
• SharedFlag: boolean
  Title: Shared

  Maximum Length: 1

  Indicates whether the service request reference is shared with the customer.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The alternative key for the service request number.
• Subject: string
  Title: Title

  Maximum Length: 1000

  The title of the referenced object.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the service request reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SharedFlag":{
            "title":"Shared",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the service request reference is shared with the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service request reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who added the reference to the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"Indicates whether the object is referenced to the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationTypeCd":{
            "title":"Relation Type",
            "maxLength":"30",
            "type":"string",
            "description":"The relationship type between the service request and the referenced object.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique document identifier associated with the referenced article.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HelpfulFlag":{
            "title":"Helpful",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the service request reference was helpful.",
            "nullable":true,
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Subject":{
            "title":"Title",
            "maxLength":"1000",
            "type":"string",
            "description":"The title of the referenced object.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LinkedFlag":{
            "title":"Linked",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the reference is linked with the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier of the current reference record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ArticleLocale":{
            "title":"Article Locale",
            "maxLength":"10",
            "type":"string",
            "description":"The locale of the knowledge management article.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The object type of the reference object.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ArticleId":{
            "title":"Article ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the referenced article.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the referenced object helps in resolving the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record 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 ID of the user who last updated the service request reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : hrHelpDeskRequests-srTags-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Tag: string
  Maximum Length: 64

  The value of the tag associated with a service request.
• TagId: integer (int64)
  Title: Tag ID

  The unique identifier of the tag.
• TagRefId: integer (int64)
  Title: Tag Reference ID

  Read Only: true

  The unique identifier of the tag associated with a service request.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The unique identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TagRefId":{
            "title":"Tag Reference ID",
            "type":"integer",
            "description":"The unique identifier of the tag associated with a service request.",
            "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"
            }
        },
        "Tag":{
            "maxLength":"64",
            "type":"string",
            "description":"The value of the tag associated with a service request.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

Links

copyAttachmentsToMessage

Operation: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/action/copyAttachmentsToMessage

copySRAttachments

Operation: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/action/copySRAttachments

Create an attachment for an HR help desk request from an existing set of attachments

Back to Top