Jump to

• Request
• Response
• Examples

Create a service request

post

/crmRestApi/resources/11.13.18.05/serviceRequests

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountPartyId: integer (int64)
  Title: Account ID

  The unique identifier of the account party associated with the service request.
• AccountPartyUniqueName: string
  Title: Account

  Maximum Length: 900

  The unique name to identify the account.
• activities: array Activities
  Title: Activities

  The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.
• addresses: array Service Addresses
  Title: Service Addresses

  A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.
• 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 person on the service request. This field is only applicable for the human resource help desk application.
• AssetId: integer (int64)
  Title: Asset

  The unique identifier of the asset associated with the service request.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 100

  The asset number associated with the service request.
• AssigneePersonName: string
  Title: Assigned To

  Maximum Length: 360

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

  The foreign key of the party object associated with the service request assignee.
• AssistedByHumanFlag: boolean
  Title: Assisted by Human Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether human agents worked on the service request at any stage of its lifecycle.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.
• BillToCustomerAccountId: integer (int64)
  Title: Bill to Customer Account ID

  The customer account to be billed for work performed on the service request.
• BillToCustomerAccountSiteId: integer (int64)
  Title: Bill to Customer Account Site ID

  The customer account site to be billed for work performed on the service request.
• BillToCustomerAccountSiteUsageNumber: string
  Title: Bill-To Customer Account Site Usage Number

  Maximum Length: 255

  The PUID for the customer account site bill-to usage.
• BillToCustomerId: integer (int64)
  Title: Bill to Customer ID

  The customer to be billed for work performed on the service request.
• BillToPartySiteFormattedAddress: string
  Title: Bill-To Party Site Formatted Address

  Maximum Length: 5000

  The formatted address for the customer site to be billed for work performed on the service request.
• BillToPartySiteId: integer (int64)
  Title: Bill-To Party Site ID

  The address of the customer site to be billed for work performed on the service request.
• BUOrgId(required): integer (int64)
  Title: Business Unit

  The unique identifier of the business unit associated with the service request.
• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case associated with the service request.
• CaseNumber: string
  Title: Case Number

  Maximum Length: 255

  The public unique identifier of the case associated with the service request.
• CategoryCode: string
  Title: Category Code

  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.
• channelCommunication: array Channel Communications
  Title: Channel Communications

  The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes 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 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.
• ClosedDate: string (date-time)
  Title: Date Closed

  The date when the service request was closed (if closed).
• contacts: array Contact Members
  Title: Contact Members

  The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• 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 currency conversion rate type associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup RatedCurrenciesVA.
• FirstTransferDate: string (date-time)
  Title: First Transfer Date

  The date when the service request was first transferred.
• HandledByAIFlag: boolean
  Title: Handled by AI Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether automation agents acted upon the service request at any point in its lifecycle.
• IBAssetId: integer (int64)
  Title: Installed Base Asset ID

  The unique identifier of the install base asset associated with the service request.
• IBAssetLocation: string
  Title: Installed Base Asset Location

  Maximum Length: 5000

  The location address of the installed base asset associated with the service request.
• InternalPriorityCd: string
  Title: Internal Priority Code

  Maximum Length: 30

  The code indicating the internal priority of the service request. For example, High, Normal, Low, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_INT_PRIORITY_CD.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

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

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

  Maximum Length: 30

  The code indicating the customer's preferred language for the service request. For example, en, fr, and so on.
• 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 last 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.
• LastUpdatedByPartyId: integer (int64)
  Title: Last Updated by Party ID

  The unique identifier of the party of the user who last updated the service request.
• LoyMemberId: integer (int64)
  Title: Loyalty Member ID

  The unique identifier of the loyalty member associated with the customer contact.
• LoyMemberName: string
  Title: Loyalty Member

  Maximum Length: 100

  The name of the loyalty member associated with the customer contact.
• messages: array Messages
  Title: Messages

  The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".
• OpenDate: string (date-time)
  Title: Date Reported

  The date when the service request was reported by the customer. Typically, the value is the same as Creation Date. However, if the service request was migrated from another system then the Creation Date is the date the SR was created and Date Reported is the date the customer reported the service request.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

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

  Maximum Length: 30

  The code indicating the type of the service request owner. For example, a customer or a partner.
• PartnerAccountPartyId: integer (int64)
  Title: Partner Account Party ID

  The unique identifier of the partner account party.
• PartnerAccountPartyName: string
  Title: Partner Account

  Maximum Length: 360

  The name of the partner account party. Two accounts can have the same party name but not the same unique name.
• PartnerAccountPartyUniqueName: string
  Title: Partner Account

  Maximum Length: 900

  The unique name to identify the partner account.
• PrimaryContactAssignmentNumber: string
  Title: Primary Contact Person Assignment Number

  Maximum Length: 50

  The unique assignment number of the primary contact of the service request.
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact ID

  The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request.
• PrimaryContactPartyName: string
  Title: Primary Contact

  Maximum Length: 360

  The name of the service request primary contact.
• PrimaryContactPartyUniqueName: string
  Title: Primary Contact Unique Name

  Maximum Length: 900

  The unique party name associated with the primary contact.
• PrimaryContactPersonId: integer (int64)
  Title: Primary Contact Person ID

  The identifier of the primary contact person of the service request. This field is only applicable for the human resource help desk application.
• ProblemCd: string
  Title: Problem Type Code

  Maximum Length: 30

  The code indicating the problem with a service request. A list of accepted values is defined in the lookup: ORA_SVC_SR_PROBLEM_TYPE_CD. For example, ORA_SVC_DOCS, ORA_SVC_PRODUCT.
• ProblemDescription: string
  Title: Problem Description

  Maximum Length: 1000

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

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

  Maximum Length: 255

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

  The public unique identifier of the product associated with the service request.
• ProductItemDescription: string
  Title: Product Description

  Maximum Length: 255

  The description of the product associated with the service request.
• PurchaseOrder: string
  Title: Purchase Order

  Maximum Length: 50

  The purchase order associated with the service request.
• 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 with the service request.
• ReportedByPartyId: integer (int64)
  Title: Reported by Party ID

  The user who created the service request in the system.
• ResolutionCd: string
  Title: Resolution Code

  Maximum Length: 30

  The code indicating the type of resolution of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.
• ResolvedBy: string
  Title: Resolved By

  Maximum Length: 64

  The name of the person who initiated the resolution process.
• ResolvedByAIFlag: boolean
  Title: Resolved by AI Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether the service request was resolved with the assistance of automation agents.
• ResolvedByPartyId: integer (int64)
  Title: Resolved by Party ID

  The unique identifier of the user who resolved this service request.
• ResolveDescription: string
  Title: Solution Description

  Maximum Length: 1000

  A brief description of how the problem was resolved.
• ResolveOutcomeCd: string
  Title: Outcome

  Maximum Length: 30

  The code indicating the type of resolution that was achieved for the Service Request.
• resourceMembers: array Resources
  Title: Resources

  Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.
• ScheduleId: integer (int64)
  Title: Schedule Identifier

  The unique identifier of the current schedule associated with the service request.
• ServiceProfileId: integer (int64)
  Title: Service Profile ID

  The service profile associated with the service request.
• ServiceProfileSiteFormattedAddress: string
  Title: Service Profile Formatted Address

  Maximum Length: 5000

  The formatted address of the service profile associated with the service request.
• ServiceZoneId: integer (int64)
  Title: Region Identifier

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

  Maximum Length: 30

  The code indicating the severity of the service request. For example, Sev1, Sev2, Sev3, and Sev4.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• SocialPrivateFlag: boolean
  Title: Private Social Post

  Maximum Length: 1

  Default Value: false

  Indicates if the service request was created from a private social post. The default value is false.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  The code indicating how the service request was created in the application. For example, Agent_UI, Customer_UI, API, and so on. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD .
• SrCreatedBy: string
  Title: Source System SR Created By

  Maximum Length: 64

  The user who created the service request.
• srInteractionReferences: array Interaction References
  Title: Interaction References

  The interaction references resource is used to view the relationship between an interaction and 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. It defaults to LAST_UPDATED_BY if null, or for migration, set to the user who last updated the row.
• SrLastUpdatedByPartyId: integer (int64)
  Title: Source System SR Last Updated By

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

  Maximum Length: 32

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

  The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.
• SrNumber: string
  Title: Reference Number

  Maximum Length: 30

  The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
• srReferences: array Service Request References
  Title: Service Request References

  The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.
• srTags: array Tags
  Title: Tags

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

  Maximum Length: 30

  The code indicating the status of the service request. For example, New, InProgress, Waiting, Resolved, Closed, and so on.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The application stripe of the service request.
• TimezoneCode: string
  Title: Time Zone Code

  Maximum Length: 50

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

  Maximum Length: 400

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

  Default Value: 0

  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.

{
    "required":[
        "BUOrgId",
        "Title"
    ],
    "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":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProdGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProdGroupName":{
            "title":"Product Group",
            "maxLength":255,
            "type":"string",
            "description":"The name of the product group associated with the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProblemDescription":{
            "title":"Problem Description",
            "maxLength":1000,
            "type":"string",
            "description":"The service request's problem description/statement and the steps to reproduce the issue.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ServiceRequestEO.ProblemDescription",
                "protectionObjectTitle":"Problem Description",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Problem Description"
            }
        },
        "ProductItemDescription":{
            "title":"Product Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the product associated with the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the service request was created in the application. For example, Agent_UI, Customer_UI, API, and so on. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD .",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup RatedCurrenciesVA.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstTransferDate":{
            "title":"First Transfer Date",
            "type":"string",
            "description":"The date when the service request was first transferred.",
            "format":"date-time",
            "nullable":true
        },
        "IBAssetId":{
            "title":"Installed Base Asset ID",
            "type":"integer",
            "description":"The unique identifier of the install base asset associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SrLastUpdatedByPartyId":{
            "title":"Source System SR Last Updated By",
            "type":"integer",
            "description":"The unique identifier of the user who last updated the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account party associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OwnerTypeCd":{
            "title":"Owner Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the service request owner. For example, a customer or a partner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the product associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryContactPersonId":{
            "title":"Primary Contact Person ID",
            "type":"integer",
            "description":"The identifier of the primary contact person of the service request. This field is only applicable for the human resource help desk application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18,
                "dependencies":[
                    "PrimaryContactAssignmentNumber"
                ]
            }
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the organization of the product that is associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssigneePersonName":{
            "title":"Assigned To",
            "maxLength":360,
            "type":"string",
            "description":"The name of the assignee.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "messages":{
            "title":"Messages",
            "type":"array",
            "description":"The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, \"We have credited your account for the value of the call. You should see a credit in your next monthly bill.\" or  \"We have notified the billing department about the issue. This issue should not recur.\".",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-item-post-request"
            }
        },
        "AssistedByHumanFlag":{
            "title":"Assisted by Human Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether human agents worked on the service request at any stage of its lifecycle.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssetId":{
            "title":"Asset",
            "type":"integer",
            "description":"The unique identifier of the asset associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "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-hints":{
                "controlType":"choice"
            }
        },
        "BillToCustomerId":{
            "title":"Bill to Customer ID",
            "type":"integer",
            "description":"The customer to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "srReferences":{
            "title":"Service Request References",
            "type":"array",
            "description":"The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srReferences-item-post-request"
            }
        },
        "ServiceProfileSiteFormattedAddress":{
            "title":"Service Profile Formatted Address",
            "maxLength":5000,
            "type":"string",
            "description":"The formatted address of the service profile associated with the service request.",
            "nullable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":900,
            "type":"string",
            "description":"The unique name to identify the account.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssigneeResourceId":{
            "title":"Assigned to Resource ID",
            "type":"integer",
            "description":"The foreign key of the party object associated with the service request assignee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "resourceMembers":{
            "title":"Resources",
            "type":"array",
            "description":"Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-resourceMembers-item-post-request"
            }
        },
        "ResolveOutcomeCd":{
            "title":"Outcome",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of resolution that was achieved for the Service Request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "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. It defaults to LAST_UPDATED_BY if null, or for migration, set to the user who last updated the row.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdatedBy"
                ]
            }
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":255,
            "type":"string",
            "description":"The public unique identifier of the case associated with the service request.",
            "nullable":true,
            "x-queryable":false
        },
        "channelCommunication":{
            "title":"Channel Communications",
            "type":"array",
            "description":"The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-channelCommunication-item-post-request"
            }
        },
        "PartnerAccountPartyId":{
            "title":"Partner Account Party ID",
            "type":"integer",
            "description":"The unique identifier of the partner account party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ServiceProfileId":{
            "title":"Service Profile ID",
            "type":"integer",
            "description":"The service profile associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SocialPrivateFlag":{
            "title":"Private Social Post",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the service request was created from a private social post. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "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
        },
        "BillToPartySiteFormattedAddress":{
            "title":"Bill-To Party Site Formatted Address",
            "maxLength":5000,
            "type":"string",
            "description":"The formatted address for the customer site to be billed for work performed on the service request.",
            "nullable":true
        },
        "BillToCustomerAccountSiteId":{
            "title":"Bill to Customer Account Site ID",
            "type":"integer",
            "description":"The customer account site to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the service request. For example, New, InProgress, Waiting, Resolved, Closed, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartnerAccountPartyUniqueName":{
            "title":"Partner Account",
            "maxLength":900,
            "type":"string",
            "description":"The unique name to identify the partner account.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "srInteractionReferences":{
            "title":"Interaction References",
            "type":"array",
            "description":"The interaction references resource is used to view the relationship between an interaction and a service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srInteractionReferences-item-post-request"
            }
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application stripe of the service request.",
            "nullable":false
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PurchaseOrder":{
            "title":"Purchase Order",
            "maxLength":50,
            "type":"string",
            "description":"The purchase order associated with the service request.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Date Closed",
            "type":"string",
            "description":"The date when the service request was closed (if closed).",
            "format":"date-time",
            "nullable":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
        },
        "ReportedByPartyId":{
            "title":"Reported by Party ID",
            "type":"integer",
            "description":"The user who created the service request in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "contacts":{
            "title":"Contact Members",
            "type":"array",
            "description":"The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-contacts-item-post-request"
            }
        },
        "addresses":{
            "title":"Service Addresses",
            "type":"array",
            "description":"A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-addresses-item-post-request"
            }
        },
        "ResolveDescription":{
            "title":"Solution Description",
            "maxLength":1000,
            "type":"string",
            "description":"A brief description of how the problem was resolved.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ServiceRequestEO.ResolveDescription",
                "protectionObjectTitle":"Solution Description",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Solution Description"
            }
        },
        "OpenDate":{
            "title":"Date Reported",
            "type":"string",
            "description":"The date when the service request was reported by the customer. Typically, the value is the same as Creation Date. However, if the service request was migrated from another system then the Creation Date is the date the SR was created and Date Reported is the date the customer reported the service request.",
            "format":"date-time",
            "nullable":false
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-Attachment-item-post-request"
            }
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":100,
            "type":"string",
            "description":"The asset number associated with the service request.",
            "nullable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-smartActions-item-post-request"
            }
        },
        "LoyMemberId":{
            "title":"Loyalty Member ID",
            "type":"integer",
            "description":"The unique identifier of the loyalty member associated with the customer contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillToCustomerAccountSiteUsageNumber":{
            "title":"Bill-To Customer Account Site Usage Number",
            "maxLength":255,
            "type":"string",
            "description":"The PUID for the customer account site bill-to usage.",
            "nullable":true
        },
        "SrLastUpdateLogin":{
            "title":"Source System SR Last Updated by User Login ID",
            "maxLength":32,
            "type":"string",
            "description":"The application login id of the user who last updated the service request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdateLogin"
                ]
            }
        },
        "HandledByAIFlag":{
            "title":"Handled by AI Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether automation agents acted upon the service request at any point in its lifecycle.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransferNote":{
            "title":"Transfer Note",
            "maxLength":1500,
            "type":"string",
            "description":"This field contains information about transfer note.",
            "nullable":true
        },
        "ProblemCd":{
            "title":"Problem Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the problem with a service request. A list of accepted values is defined in the lookup: ORA_SVC_SR_PROBLEM_TYPE_CD. For example, ORA_SVC_DOCS, ORA_SVC_PRODUCT.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerAccountPartyName":{
            "title":"Partner Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner account party. Two accounts can have the same party name but not the same unique name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetLocation":{
            "title":"Installed Base Asset Location",
            "maxLength":5000,
            "type":"string",
            "description":"The location address of the installed base asset associated with the service request.",
            "nullable":true,
            "x-queryable":false
        },
        "AffectedPartyPersonId":{
            "title":"Affected Party",
            "type":"string",
            "description":"The unique identifier of the affected person on the service request. This field is only applicable for the human resource help desk application.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AffectedPartyAssignmentNumber"
                ]
            }
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "type":"string",
            "description":"The public unique identifier of the product associated with the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SeverityCd":{
            "title":"Severity",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the severity of the service request. For example, Sev1, Sev2, Sev3, and Sev4.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
            }
        },
        "srTags":{
            "title":"Tags",
            "type":"array",
            "description":"The tags resource is used to view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srTags-item-post-request"
            }
        },
        "LanguageCd":{
            "title":"Language Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the customer's preferred language for the service request. For example, en, fr, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "srMilestone":{
            "title":"Milestones",
            "type":"array",
            "description":"The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srMilestone-item-post-request"
            }
        },
        "TransferReasonCd":{
            "title":"Transfer Reason",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the transfer reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of resolution of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ResolveOutcomeCd"
                ]
            }
        },
        "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":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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-hints":{
                "controlType":"check_box"
            }
        },
        "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
        },
        "ResolvedByAIFlag":{
            "title":"Resolved by AI Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request was resolved with the assistance of automation agents.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToCustomerAccountId":{
            "title":"Bill to Customer Account ID",
            "type":"integer",
            "description":"The customer account to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CategoryId":{
            "title":"Category",
            "type":"integer",
            "description":"The unique identifier of the service request category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18,
                "dependencies":[
                    "BUOrgId",
                    "StripeCd"
                ]
            }
        },
        "LastResolvedDate":{
            "title":"Resolution Date",
            "type":"string",
            "description":"The date and time when the service request was last resolved.",
            "format":"date-time",
            "nullable":true
        },
        "TransferCount":{
            "title":"Transfer Count",
            "type":"integer",
            "description":"The count showing how many times a service request has been transferred.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "ChannelId":{
            "title":"Channel",
            "type":"integer",
            "description":"The unique identifier of the service request channel.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":360,
            "type":"string",
            "description":"The name of the service request primary contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactPartyUniqueName":{
            "title":"Primary Contact Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name associated with the primary contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InternalPriorityCd":{
            "title":"Internal Priority Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the internal priority of the service request. For example, High, Normal, Low, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_INT_PRIORITY_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "QueueName":{
            "title":"Queue",
            "maxLength":400,
            "type":"string",
            "description":"The name of the queue associated with the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ResolvedByPartyId":{
            "title":"Resolved by Party ID",
            "type":"integer",
            "description":"The unique identifier of the user who resolved this service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillToPartySiteId":{
            "title":"Bill-To Party Site ID",
            "type":"integer",
            "description":"The address of the customer site to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdatedByPartyId":{
            "title":"Last Updated by Party ID",
            "type":"integer",
            "description":"The unique identifier of the party of the user who last updated the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The reference to the service request record in the original system from which service request was imported (if imported).",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SrNumber"
                ]
            }
        },
        "Title":{
            "title":"Title",
            "maxLength":400,
            "type":"string",
            "description":"A brief title of the service request.",
            "nullable":false
        },
        "ScheduleId":{
            "title":"Schedule Identifier",
            "type":"integer",
            "description":"The unique identifier of the current schedule associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SrNumber":{
            "title":"Reference Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.",
            "nullable":false
        },
        "LastReopenDate":{
            "title":"Date Reopened",
            "type":"string",
            "description":"The date and time when the service request was last reopened.",
            "format":"date-time",
            "nullable":true
        },
        "ResolvedBy":{
            "title":"Resolved By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the person who initiated the resolution process.",
            "nullable":true
        },
        "activities":{
            "title":"Activities",
            "type":"array",
            "description":"The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-activities-item-post-request"
            }
        },
        "LoyMemberName":{
            "title":"Loyalty Member",
            "maxLength":100,
            "type":"string",
            "description":"The name of the loyalty member associated with the customer contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "LastTransferredBy":{
            "title":"Last Transferred By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last transferred the service request.",
            "nullable":true
        },
        "ServiceZoneId":{
            "title":"Region Identifier",
            "type":"integer",
            "description":"The unique identifier of the service request region.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

Nested Schema : Activities

Type: array

Title: Activities

The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.

Show Source

• Array of: object schema

{
    "title":"Activities",
    "type":"array",
    "description":"The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-activities-item-post-request"
    }
}

Nested Schema : Service Addresses

Type: array

Title: Service Addresses

A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.

Show Source

• Array of: object schema

{
    "title":"Service Addresses",
    "type":"array",
    "description":"A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-addresses-item-post-request"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-Attachment-item-post-request"
    }
}

Nested Schema : Channel Communications

Type: array

Title: Channel Communications

The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.

Show Source

• Array of: object schema

{
    "title":"Channel Communications",
    "type":"array",
    "description":"The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-channelCommunication-item-post-request"
    }
}

Nested Schema : Contact Members

Type: array

Title: Contact Members

The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.

Show Source

• Array of: object schema

{
    "title":"Contact Members",
    "type":"array",
    "description":"The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-contacts-item-post-request"
    }
}

Nested Schema : Messages

Type: array

Title: Messages

The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".

Show Source

• Array of: object serviceRequests-messages-item-post-request

{
    "title":"Messages",
    "type":"array",
    "description":"The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, \"We have credited your account for the value of the call. You should see a credit in your next monthly bill.\" or  \"We have notified the billing department about the issue. This issue should not recur.\".",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-messages-item-post-request"
    }
}

Nested Schema : Resources

Type: array

Title: Resources

Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.

Show Source

• Array of: object serviceRequests-resourceMembers-item-post-request

{
    "title":"Resources",
    "type":"array",
    "description":"Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-resourceMembers-item-post-request"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object serviceRequests-smartActions-item-post-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-smartActions-item-post-request"
    }
}

Nested Schema : Interaction References

Type: array

Title: Interaction References

The interaction references resource is used to view the relationship between an interaction and a service request.

Show Source

• Array of: object serviceRequests-srInteractionReferences-item-post-request

{
    "title":"Interaction References",
    "type":"array",
    "description":"The interaction references resource is used to view the relationship between an interaction and a service request.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srInteractionReferences-item-post-request"
    }
}

Nested Schema : Milestones

Type: array

Title: Milestones

The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.

Show Source

• Array of: object serviceRequests-srMilestone-item-post-request

{
    "title":"Milestones",
    "type":"array",
    "description":"The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srMilestone-item-post-request"
    }
}

Nested Schema : Service Request References

Type: array

Title: Service Request References

The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.

Show Source

• Array of: object schema

{
    "title":"Service Request References",
    "type":"array",
    "description":"The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srReferences-item-post-request"
    }
}

Nested Schema : Tags

Type: array

Title: Tags

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

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account ID

  The unique identifier of the activity account, for example customer, organization, person, or partner.
• AccountIdAttr: integer
  The unique identifier of the account. This attribute is for internal use.
• AccountName: string
  Title: Account

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

  The account name displayed in Oracle Social Network.
• ActivityDescription: string (byte)
  Title: Description

  A text area for capturing information about the activity.
• ActivityEndDate: string (date-time)
  Title: End Date

  The date and time of when an appointment ends. The time when a task is completed.
• ActivityFunctionCode: string
  Title: Activity

  Maximum Length: 30

  The code indicating the function of the activity.
• ActivityFunctionCodeTrans: string
  Title: Activity

  Maximum Length: 255

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

  The unique identifier of the activity.
• ActivityMtgMinutes: string (byte)
  Title: Meeting Minutes

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

  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• ActivityPartialDescription: string
  Title: Short Description

  Maximum Length: 4000

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

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

  The date and time when an appointment or a task begins. The default value for an appointment is null. The default value for a task is the date and time of when a task is created.
• ActivitySubtypeCode: string
  Title: Subtype

  Maximum Length: 30

  The code indicating the activity subtype that is dependent on the activity type.
• ActivityTimezone: string
  The time zone that the activity needs to be created in, other than the default logged user's time zone preference.
• ActivityType: string
  Title: Activity Type

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

  Maximum Length: 30

  The code indicating the type or category of the activity.
• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: false

  Indicates whether the appointment is for the entire day. If the value is True, the appointment is for the entire day. The default value is False.
• 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 that is associated to the activity or the activity template.
• AssetId: integer (int64)
  Title: Asset ID

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

  The name of the asset associated with an activity.
• AssetNumber: string
  Title: Asset Number

  The alternate key identifier of the activity.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: ZMM_ACTY_ACTIVITIES

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

  Maximum Length: 30

  The name of the source for the activity.
• BpId: integer (int64)
  Title: Business Plan ID

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

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

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

  The public unique identifier of business plan associated with the activity.
• CalendarAccess: boolean
  Indicates who has access to the calender.
• CalendarRecurType: string
  The activity recurrence type.
• CalendarSubject: string
  The subject of the activity.
• CalendarSubjectDay: string
  The title of the calender.
• CalendarTimeType: string
  The calender time type of the activity.
• CallReportCount: integer (int32)
  Title: Call Report Count

  Default Value: 0

  A count of the number of call reports.
• CallReportUpcomingYN: string
  Indicates the status of the call report for upcoming appointments.
• CallReportYN: string
  Indicates whether the activity is associated with a call report.
• CampaignId: integer (int64)
  Title: Campaign ID

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

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

  The public unique identifier 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 case number associated with the activity.
• CheckedInBy: string
  Title: Checked-In By

  Maximum Length: 64

  The person who checked into a location.
• CheckedOutBy: string
  Title: Checked-Out By

  Maximum Length: 64

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

  The date and time when a user checks in to a location.
• CheckinLatitude: number
  Title: Check-In Latitude

  The latitude when a user checks in to a location.
• CheckinLongitude: number
  Title: Check-In Longitude

  The longitude when a user checks in to a location.
• CheckoutDate: string (date-time)
  Title: Check-Out Time

  The date and time when a user checks out of a location.
• CheckoutLatitude: number
  Title: Check-Out Latitude

  The latitude when a user checks out of a location.
• CheckoutLongitude: number
  Title: Check-Out Longitude

  The longitude when a user checks out of a location.
• ClaimId: integer (int64)
  Title: Claim ID

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

  The name of the claim associated with the activity.
• ClaimNumber: string
  Title: Claim Number

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

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.
• ContactIDAttr: integer
  The unique identifier of the contact. This attribute is for internal use.
• CorpCurrencyCode: string
  Title: Corporate Currency

  Maximum Length: 15

  The corporate currency code associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurcyConvRateType: string
  Title: Currency Conversion Rate

  Maximum Length: 30

  The currency conversion rate type associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrentDateForCallReport: string (date-time)
  The current date for the Call Report.
• CurrentDateForCallReportAttr: string (date-time)
  The current date of the call report. This attribute is for internal use.
• CustomerAccountId: integer (int64)
  Title: Customer Account ID

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

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

  The alternate key identifier of the deal associated to the activity. The number can also be generated from an external source.
• DelegatorId: integer (int64)
  Title: Delegator ID

  The unique identifier of the user who delegated the activity to another activity resource.
• DelegatorName: string
  Title: Delegated By

  The name of the user who delegated the activity to another activity resource.
• DerivedAccountId: integer
  The unique identifier of the account.
• DirectionCode: string
  Title: Direction

  Maximum Length: 30

  The code indicating the direction of an activity. The options are inbound/outbound, optional. The default value is null.
• DismissAssignee: string
  Title: Dismissed

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

  Maximum Length: 1

  Indicates if the calls that were logged for a past appointment are dismissed.
• DueDate: string (date)
  Title: Due Date

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

  The duration of an appointment or task.
• EmailSentDate: string (date-time)
  The date and time when the activity e-mail notifications are shared through Outlook.
• EndDateForCallReport: string (date-time)
  The date when the call report ends.
• EndDateForCallReportAttr: string (date-time)
  The end date of the call report. This attribute is for internal use.
• EndDtRFAttr: string (date-time)
  The date when the activity ends. This attribute is for internal use.
• ExternalContactEmail: string
  Title: Primary Email

  Maximum Length: 320

  The e-mail 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 whether the activity is created by an external resource.
• FundRequestId: integer (int64)
  Title: Fund Request ID

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

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

  The public unique identifier 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.
• InstNumDerivedFrom: string
  Default Value: Y

  The attribute identifies the recurrence mode. This attribute is for internal use.
• IsClientService: string
  Default Value: Y

  This is obsolete and was for internal usage.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier of the related lead.
• LeadIdAttr: integer
  The unique identifier of the lead. This attribute is for internal use.
• LeadName: string
  Title: Lead

  The name of the activity lead.
• LeadNameOsn: string
  Title: Social Lead Name

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

  The public unique identifier of the lead associated with the activity.
• Location: string
  Title: Location

  Maximum Length: 200

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

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

  Maximum Length: 50

  The code indicating whether an external mobile was used for an activity.
• 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 unique identifier of the opportunity. This attribute is for internal use.
• OpportunityName: string
  Title: Opportunity

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

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

  The public unique identifier 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 identifier of the activity.
• OtherPartyPhoneNumber: string
  Title: Other Party Phone Number

  Maximum Length: 40

  The inbound phone number that is used to make a call. Identifies the phone number dialed for outbound calls.
• OutcomeCode: string
  Title: Outcome

  Maximum Length: 30

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

  Maximum Length: 1

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

  Maximum Length: 1

  Default Value: false

  Indicates whether the activity is created in Outlook. If the value is Y, then the activity is created in Outlook and synchronized.
• 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 for the activity in Outlook.
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier of the activity owner.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The name of the owner of the activity.
• OwnerNameOsn: string
  Title: Social Owner Name

  The owner name displayed in Oracle Social Network.
• ParentActivityId: integer (int64)
  Title: Parent ID

  The unique identifier of the related activity ID, only applicable if the record is a follow up activity.
• ParentActivityIdAttr: string
  The unique identifier of the parent activity. This attribute is for internal use.
• 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 related program enrollment.
• PartnerEnrollmentNumber: string
  Title: Enrollment Number

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

  The unique identifier of the party associated with the partner account.
• PartnerPartyName: string
  Title: Partner

  Maximum Length: 80

  The name of the party associated with the partner account.
• PartnerPartyNumber: string
  Title: Partner Number

  The public unique identifier of partner associated with the activity.
• PartnerProgramId: integer (int64)
  Title: Partner Program ID

  The unique identifier of the related partner program.
• PartnerProgramName: string
  Title: Program

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

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

  Maximum Length: 1

  Default Value: false

  Indicates whether the activity is created for an organization account with usage as Partner.
• PercentageComplete: number
  Title: Percentage Complete

  Default Value: 0

  The amount of activity completed in percentage. This is a free form numeric value ranging from 0 to 100.
• PrimaryContactId: integer (int64)
  Title: Primary Contact ID

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

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

  The primary contact name displayed in Oracle Social Network.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  The code indicating the priority of the activity. The default value is 2. The possible values are, 1, 2, or 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

  The recurrence of an appointment on a specific day of the month.
• RecurEndDate: string (date-time)
  Title: Ends

  The date when a recurring activity ends.
• RecurEveryOptionFlag: boolean
  Title: Recurrence Option

  Maximum Length: 1

  Indicates the frequency of recurrence of an activity. If the recurrence is everyday of the week, it is set to Y if it is weekdays only, it is set to N. The recurring options are every day, week, month, year, and so on.
• RecurExceptionFlag: boolean
  Title: Recurrence Exception

  Maximum Length: 1

  Indicates if the appointment instance is updated outside the recurring appointment series.
• RecurFrequency: number
  Title: Repeat

  The frequency with which the recurring appointment series repeats.
• RecurFriFlag: boolean
  Title: Friday

  Maximum Length: 1

  Indicates if an appointment recurs every Friday.
• RecurMonFlag: boolean
  Title: Monday

  Maximum Length: 1

  Indicates if an appointment recurs every Monday.
• RecurMonth: string
  Title: Month

  Maximum Length: 30

  The recurrence of an appointment in a specified month.
• RecurNumberOfInstances: number
  Title: Number of Instances

  The specific number of occurrences for the series, after which the recurring series ends.
• RecurOrigInstDate: string (date-time)
  Title: Original Instance Date

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

  Maximum Length: 30

  The recurring appointment for a specific week, for example, First, Second, Third, Fourth, Last. The recurrence can be monthly or yearly.
• RecurRecType: string
  Title: Recurrence Record Type

  Maximum Length: 1

  Default Value: N

  The type of recurrence of an Activity, for example "I" for instance, "S" for series, or "N" for non-recurring. For Internal Use Only. Do not populate it if Activity is of type Task.
• RecurSatFlag: boolean
  Title: Saturday

  Maximum Length: 1

  Indicates if the activity recurs on Saturday.
• RecurSeriesId: integer (int64)
  Title: Recurrence Series ID

  The unique identifier for the series that links instances of a series together.
• RecurSunFlag: boolean
  Title: Sunday

  Maximum Length: 1

  Indicates if the activity recurs on Sunday.
• RecurThuFlag: boolean
  Title: Thursday

  Maximum Length: 1

  Indicates if the activity recurs on Thursday.
• RecurTueFlag: boolean
  Title: Tuesday

  Maximum Length: 1

  Indicates if the activity recurs on Tuesday.
• RecurTypeCode: string
  Title: Recurrence Type

  Maximum Length: 30

  The code indicating how often an appointment recurs, for example Daily, Weekly, Monthly, or 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

  Indicates if the activity recurs on Wednesday.
• RecurWeekday: string
  Title: Pattern Type

  Maximum Length: 30

  The type of recurrence of an activity, for example Monday to Sunday, Weekday, Weekend, or a specific Day.
• ReferenceCustomerActTypeCode: string
  Title: Reference Customer Activity Type

  Maximum Length: 30

  The activity that refers to the activity of a customer. To be used for adjustment only.
• ReferenceCustomerId: integer (int64)
  Title: Reference Customer

  The unique identifier of the referenced customer who is associated with the activity.
• ReminderPeriod: string
  Title: Set Reminder

  Indicates when the reminder should be sent.
• ResponseCode: string
  Title: Response

  Indicates whether a reminder is required.
• SalesObjectiveName: string
  Title: Sales Objective

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

  The public unique identifier of 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

  The show status of the the activity such as open, complete, or all activities.
• ShowTimeAs: string
  Title: Show Time As

  The choice of display of time on your calendar for an 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

  The date used to sort the activities. The sort date can be the appointment start date, the task due date, or the task complete date.
• SourceObjectCode: string
  The code indicating the source object associated with the activity.
• SourceObjectId: integer
  The unique identifier of the object associated with the activity.
• SrId: integer (int64)
  Title: Service Request ID

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

  The alternate key identifier of the service request.
• StartDateForCallReport: string (date-time)
  The date when the call report starts.
• StartDateForCallReportAttr: string (date-time)
  The start date of the call report. This attribute is for internal use.
• StartDtRFAttr: string (date-time)
  The date when the activity starts. This attribute is for internal use.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The status of the activity. The default value is Not Started.
• Subject: string
  Title: Subject

  Maximum Length: 500

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

  The user who submitted the Call Report.
• SubmittedByName: string
  Title: Submitted By

  Maximum Length: 255

  The name of the user who submitted the Call Report.
• SubmittedDate: string (date-time)
  Title: Submitted Date

  The date and time when the Call Report was submitted.
• 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 reminder period for a task due date, such as one day before the task due date.
• TemplateDuration: number
  Title: Template Duration

  The duration in number of days, for the template activity. This attribute is used with the start date when generating an activity from a template in order 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

  Ithe identifier of the template associated with the activity.
• TemplateLeadTime: number
  Title: Lead Time

  The lead time that is calculated from the activity start date, for the template activity.
• 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 person who checks out of a location.",
            "nullable":true
        },
        "FundRequestNumber":{
            "title":"Fund Request Number",
            "type":"string",
            "description":"The public unique identifier of the fund request associated with the activity.",
            "nullable":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
            }
        },
        "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":"The currency conversion rate type associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "WebConferenceId":{
            "title":"Web Conference ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the web conference.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ShowStatus":{
            "title":"Show",
            "maxLength":255,
            "type":"string",
            "description":"The show status of the the activity such as open, complete, or all activities.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PercentageComplete":{
            "title":"Percentage Complete",
            "type":"number",
            "description":"The amount of activity completed in percentage. This is a free form numeric value ranging from 0 to 100.",
            "nullable":true,
            "default":0
        },
        "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
            }
        },
        "PartialMtgMinutes":{
            "title":"Short Meeting Minutes",
            "maxLength":4000,
            "type":"string",
            "description":"A column that stores a truncated string of the meeting minutes.",
            "nullable":true
        },
        "RecurFrequency":{
            "title":"Repeat",
            "type":"number",
            "description":"The frequency with which the recurring appointment series repeats.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityPriority":{
            "title":"Priority",
            "type":"string",
            "description":"The priority of the activity (Internal Usage).",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriorityCode"
                ]
            }
        },
        "ActivityFunctionCode":{
            "title":"Activity",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of the activity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The unique identifier of the related partner program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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":"Indicates if an appointment recurs every 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 calender.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrentDateForCallReportAttr":{
            "type":"string",
            "description":"The current date of the call report. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true
        },
        "DelegatorId":{
            "title":"Delegator ID",
            "type":"integer",
            "description":"The unique identifier of the user who delegated the activity to another activity resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecurWeekday":{
            "title":"Pattern Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of recurrence of an activity, for example Monday to Sunday, Weekday, Weekend, or a specific 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
            }
        },
        "RecurTueFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs on Tuesday.",
            "nullable":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
            }
        },
        "ReferenceCustomerActTypeCode":{
            "title":"Reference Customer Activity Type",
            "maxLength":30,
            "type":"string",
            "description":"The activity that refers to the activity of a customer. To be used for adjustment only.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartnerUsageFlag":{
            "title":"Partner Usage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity is 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 reminder period for a task due date, such as one day before the task due date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstNumDerivedFrom":{
            "type":"string",
            "description":"The attribute identifies the recurrence mode. This attribute is for internal use.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the related campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OpportunityId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the related opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StartDtRFAttr":{
            "type":"string",
            "description":"The date when the activity starts. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true
        },
        "SmartActionContext":{
            "title":"Smart Action Context",
            "maxLength":4000,
            "type":"string",
            "description":"Stores metadata needed for smart action.",
            "nullable":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
            }
        },
        "ResponseCode":{
            "title":"Response",
            "type":"string",
            "description":"Indicates whether a reminder is required.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IsClientService":{
            "type":"string",
            "description":"This is obsolete and was for internal usage.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "ActivityTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type or category of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist",
                "Dependencies":"ActivityFunctionCode"
            }
        },
        "OutlookAutoSyncFlag":{
            "title":"Microsoft Auto-Synchronization",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an appointment was generated by the synchronization process from Microsoft 365.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ActivityMtgMinutes":{
            "title":"Meeting Minutes",
            "type":"string",
            "description":"The minutes of an activity meeting.",
            "format":"byte",
            "nullable":true
        },
        "SortDate":{
            "title":"Date",
            "type":"string",
            "description":"The date used to sort the activities. The sort date can be the appointment start date, the task due date, or the task complete date.",
            "format":"date-time",
            "nullable":true
        },
        "SalesObjectiveNumber":{
            "title":"Sales Objective Number",
            "type":"string",
            "description":"The public unique identifier of sales objective associated with the activity.",
            "nullable":true
        },
        "ParentActivityIdAttr":{
            "type":"string",
            "description":"The unique identifier of the parent activity. This attribute is for internal use.",
            "nullable":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"
            }
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object associated with the activity.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceCustomerId":{
            "title":"Reference Customer",
            "type":"integer",
            "description":"The unique identifier of the referenced customer who is associated with the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CheckedInBy":{
            "title":"Checked-In By",
            "maxLength":64,
            "type":"string",
            "description":"The person who checked into a location.",
            "nullable":true
        },
        "DerivedAccountId":{
            "type":"integer",
            "description":"The unique identifier of the account.",
            "nullable":true,
            "x-queryable":false
        },
        "OutcomeCode":{
            "title":"Outcome",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the outcome of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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 activity account, for example customer, organization, person, or partner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExternallyOwnedFlag":{
            "title":"Externally Owned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity is created by an external resource.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "OutlookIdentifier":{
            "title":"Outlook Identifier",
            "maxLength":1024,
            "type":"string",
            "description":"The unique identifier for the activity in Outlook.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the activity. The default value is Not Started.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DelegatorName":{
            "title":"Delegated By",
            "type":"string",
            "description":"The name of the user who delegated the activity to another activity resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CheckinLatitude":{
            "title":"Check-In Latitude",
            "type":"number",
            "description":"The latitude when a user checks in to a location.",
            "nullable":true
        },
        "EndDateForCallReport":{
            "type":"string",
            "description":"The date when the call report ends.",
            "format":"date-time",
            "nullable":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"
            }
        },
        "WebconfSyncStatusFlag":{
            "title":"Web Conference Synchronization",
            "maxLength":1,
            "type":"boolean",
            "description":"The appointment interaction status.",
            "nullable":true
        },
        "OutlookGlobalId":{
            "title":"Outlook Global ID",
            "maxLength":1024,
            "type":"string",
            "description":"The unique identifier of an appointment created from Microsoft 365.",
            "nullable":true
        },
        "PartnerPartyId":{
            "title":"Partner Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the partner account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActivitySubtypeCode":{
            "title":"Subtype",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the activity subtype that is dependent on the activity type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ActivityTypeCode",
                    "ActivityFunctionCode"
                ]
            }
        },
        "SalesObjectiveName":{
            "title":"Sales Objective",
            "type":"string",
            "description":"The name of the sales objective associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "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 user who submitted the Call Report.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetName":{
            "title":"Asset",
            "type":"string",
            "description":"The name of the asset associated with an activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CheckoutLongitude":{
            "title":"Check-Out Longitude",
            "type":"number",
            "description":"The longitude when a user checks out of a location.",
            "nullable":true
        },
        "OpportunityName":{
            "title":"Opportunity",
            "type":"string",
            "description":"The name of the opportunity associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "OpportunityId"
                ]
            }
        },
        "OtherPartyPhoneNumber":{
            "title":"Other Party Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The inbound phone number that is used to make a call. Identifies the phone number dialed for outbound calls.",
            "nullable":true
        },
        "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"
                ]
            }
        },
        "TemplateFlag":{
            "title":"Template",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this is a template activity.",
            "nullable":true,
            "default":"N"
        },
        "OutlookFlag":{
            "title":"Outlook",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity is created in Outlook. If the value is Y, then the activity is created in Outlook and synchronized.",
            "nullable":true,
            "default":false
        },
        "RecurUpdatedAttributes":{
            "title":"Recurrence Updated Attributes",
            "maxLength":4000,
            "type":"string",
            "description":"The updated field references for recurring appointment exception records.",
            "nullable":true
        },
        "CheckoutDate":{
            "title":"Check-Out Time",
            "type":"string",
            "description":"The date and time when a user checks out of a location.",
            "format":"date-time",
            "nullable":true
        },
        "PartnerEnrollmentId":{
            "title":"Enrollment ID",
            "type":"integer",
            "description":"The unique identifier of the related program enrollment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date and time when the Call Report was submitted.",
            "format":"date-time",
            "nullable":true
        },
        "PartnerPartyNumber":{
            "title":"Partner Number",
            "type":"string",
            "description":"The public unique identifier of partner associated with the activity.",
            "nullable":true
        },
        "RecurEveryOptionFlag":{
            "title":"Recurrence Option",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the frequency of recurrence of an activity. If the recurrence is everyday of the week, it is set to Y if it is weekdays only, it is set to N. The recurring options are every day, week, month, year, and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "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 name of the party associated with the partner account.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RecurRecType":{
            "title":"Recurrence Record Type",
            "maxLength":1,
            "type":"string",
            "description":"The type of recurrence of an Activity, for example \"I\" for instance, \"S\" for series, or \"N\" for non-recurring. For Internal Use Only. Do not populate it if Activity is of type Task.",
            "nullable":true,
            "default":"N"
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account related to the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the related lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecurPattern":{
            "title":"Pattern",
            "maxLength":30,
            "type":"string",
            "description":"The recurring appointment for a specific week, for example, First, Second, Third, Fourth, Last. The recurrence can be monthly or yearly.",
            "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
            }
        },
        "SrNumber":{
            "title":"Service Request",
            "type":"string",
            "description":"The alternate key identifier of the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SrId"
                ]
            }
        },
        "MdfRequestId":{
            "type":"integer",
            "description":"The unique identifier of the fund request.",
            "nullable":true,
            "x-queryable":false
        },
        "Subject":{
            "title":"Subject",
            "maxLength":500,
            "type":"string",
            "description":"The title of the activity.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            }
        },
        "ActivityEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time of when an appointment ends. The time when a task is completed.",
            "format":"date-time",
            "nullable":true
        },
        "ReminderPeriod":{
            "title":"Set Reminder",
            "type":"string",
            "description":"Indicates when the reminder should be sent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurNumberOfInstances":{
            "title":"Number of Instances",
            "type":"number",
            "description":"The specific number of occurrences for the series, after which the recurring series ends.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadName":{
            "title":"Lead",
            "type":"string",
            "description":"The name of the activity lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "LeadId"
                ]
            }
        },
        "StartDateForCallReportAttr":{
            "type":"string",
            "description":"The start date of the call report. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true
        },
        "RecurSeriesId":{
            "title":"Recurrence Series ID",
            "type":"integer",
            "description":"The unique identifier for the series that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Location":{
            "title":"Location",
            "maxLength":200,
            "type":"string",
            "description":"The location of the appointment.",
            "nullable":true
        },
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the related deal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CheckinDate":{
            "title":"Check-In Time",
            "type":"string",
            "description":"The date and time when a user checks in to a location.",
            "format":"date-time",
            "nullable":true
        },
        "MobileActivityCode":{
            "title":"Mobile Activity Code",
            "maxLength":50,
            "type":"string",
            "description":"The code indicating whether an external mobile was used for an activity.",
            "nullable":true,
            "x-queryable":false
        },
        "AutoLogSource":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The name of the source for the activity.",
            "nullable":true
        },
        "LeadIdAttr":{
            "type":"integer",
            "description":"The unique identifier of the lead. This attribute is for internal use.",
            "nullable":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"
            }
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).  This attribute is obsolete.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "ContactIDAttr":{
            "type":"integer",
            "description":"The unique identifier of the contact. This attribute is for internal use.",
            "nullable":true
        },
        "SourceObjectCode":{
            "type":"string",
            "description":"The code indicating the source object associated with the activity.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "type":"string",
            "description":"The public unique identifier of the campaign associated with the activity.",
            "nullable":true
        },
        "CallReportUpcomingYN":{
            "type":"string",
            "description":"Indicates the status of the call report for upcoming appointments.",
            "nullable":true
        },
        "PrimaryContactName":{
            "title":"Primary Contact",
            "type":"string",
            "description":"The name of the primary contact of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RecurEndDate":{
            "title":"Ends",
            "type":"string",
            "description":"The date when a recurring activity ends.",
            "format":"date-time",
            "nullable":true
        },
        "RecurMonFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if an appointment recurs every Monday.",
            "nullable":true,
            "x-queryable":false
        },
        "OpportunityNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"The public unique identifier of the opportunity associated with the activity.",
            "nullable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "type":"integer",
            "description":"The user who submitted the Call Report.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"The public unique identifier of the lead associated with the activity.",
            "nullable":true
        },
        "CalendarSubject":{
            "type":"string",
            "description":"The subject of the activity.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of an asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The name of the account associated with the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PartnerProgramNumber":{
            "title":"Program Number",
            "type":"string",
            "description":"The public unique identifier of partner program associated with the activity.",
            "nullable":true
        },
        "PrimaryContactId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the activity contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the priority of the activity. The default value is 2. The possible values are, 1, 2, or 3.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DealNumber":{
            "title":"Deal Registration",
            "type":"string",
            "description":"The alternate key identifier of the deal associated to the activity. The number can also be generated from an external source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EndDtRFAttr":{
            "type":"string",
            "description":"The date when the activity ends. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true
        },
        "ExternalContactEmail":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of an external contact.",
            "nullable":true
        },
        "DismissAssignee":{
            "title":"Dismissed",
            "type":"string",
            "description":"Indicates whether the assignee is dismissed. Valid values are Y and N.",
            "nullable":true
        },
        "OpportunityIdAttr":{
            "type":"integer",
            "description":"The unique identifier of the opportunity. This attribute is for internal use.",
            "nullable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the activity owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityFunctionCodeTrans":{
            "title":"Activity",
            "maxLength":255,
            "type":"string",
            "description":"The activity function code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CaseNumber":{
            "title":"Case Number",
            "type":"string",
            "description":"The case number associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CaseId"
                ]
            }
        },
        "RecurWedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs on Wednesday.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDateForCallReport":{
            "type":"string",
            "description":"The date when the call report starts.",
            "format":"date-time",
            "nullable":true
        },
        "TemplateDuration":{
            "title":"Template Duration",
            "type":"number",
            "description":"The duration in number of days, for the template activity. This attribute is used with the start date when generating an activity from a template in order to calculate the due date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":3
            }
        },
        "RecurSatFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs on Saturday.",
            "nullable":true,
            "x-queryable":false
        },
        "ClaimNumber":{
            "title":"Claim Number",
            "type":"string",
            "description":"The public unique identifier of the claim associated with the activity.",
            "nullable":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
            }
        },
        "DismissFlag":{
            "title":"Dismissed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the calls that were logged for a past appointment are dismissed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the account or contact location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecurThuFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs 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
            }
        },
        "ArticleVersionId":{
            "title":"Article Version ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the article version.",
            "nullable":true
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the fund request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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 login of the user of the activity. This attribute is for internal use.",
            "nullable":true
        },
        "PartnerProgramName":{
            "title":"Program",
            "type":"string",
            "description":"The name of the partner program associated with the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerProgramId"
                ]
            }
        },
        "RecurTypeCode":{
            "title":"Recurrence Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how often an appointment recurs, for example Daily, Weekly, Monthly, or Yearly.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDateForCallReportAttr":{
            "type":"string",
            "description":"The end date of the call report. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true
        },
        "OsnActivityId":{
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecurExceptionFlag":{
            "title":"Recurrence Exception",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the appointment instance is updated outside the recurring appointment series.",
            "nullable":true
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The attachment of the entity name.",
            "nullable":true,
            "default":"ZMM_ACTY_ACTIVITIES",
            "x-queryable":false
        },
        "CallReportYN":{
            "type":"string",
            "description":"Indicates whether the activity is associated with a call report.",
            "nullable":true
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity is private.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "WebConferenceURL":{
            "title":"Web Conference URL",
            "maxLength":2000,
            "type":"string",
            "description":"The web conference join URL.",
            "nullable":true
        },
        "CheckoutLatitude":{
            "title":"Check-Out Latitude",
            "type":"number",
            "description":"The latitude when a user checks out of a location.",
            "nullable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "type":"string",
            "description":"The alternate key identifier of the activity.",
            "nullable":true
        },
        "BusinessPlanName":{
            "title":"Business Plan",
            "type":"string",
            "description":"The name of the business plan associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":64,
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":false
        },
        "FundRequestName":{
            "title":"MDF Request",
            "type":"string",
            "description":"The name of the fund request associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurrentDateForCallReport":{
            "type":"string",
            "description":"The current date for the Call Report.",
            "format":"date-time",
            "nullable":true
        },
        "CheckinLongitude":{
            "title":"Check-In Longitude",
            "type":"number",
            "description":"The longitude when a user checks in to a location.",
            "nullable":true
        },
        "RecurOrigInstDate":{
            "title":"Original Instance Date",
            "type":"string",
            "description":"The original date of a recurring appointment instance.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RecurSunFlag":{
            "title":"Sunday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs on Sunday.",
            "nullable":true,
            "x-queryable":false
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the appointment is for the entire day. If the value is True, the appointment is for the entire day. The default value is False.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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
        },
        "EmailSentDate":{
            "type":"string",
            "description":"The date and time when the activity e-mail notifications are shared through Outlook.",
            "format":"date-time",
            "nullable":true
        },
        "ClaimName":{
            "title":"MDF Claim",
            "type":"string",
            "description":"The name of the claim associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of the assessment that is associated to the activity or the activity template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CalendarTimeType":{
            "type":"string",
            "description":"The calender time type of the activity.",
            "nullable":true
        },
        "RecurMonth":{
            "title":"Month",
            "maxLength":30,
            "type":"string",
            "description":"The recurrence of an appointment in a specified month.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActivityTimezone":{
            "type":"string",
            "description":"The time zone that the activity needs to be created in, other than the default logged user's time zone preference.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the owner of the activity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityDescription":{
            "title":"Description",
            "type":"string",
            "description":"A text area for capturing information about the activity.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ActivityEO.ActivityDesc",
                "protectionState":"TOKENIZED"
            }
        },
        "RecurDay":{
            "title":"Day",
            "type":"integer",
            "description":"The recurrence of an appointment on a specific day of the month.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ActivityStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when an appointment or a task begins. The default value for an appointment is null. The default value for a task is the date and time of when a task is created.",
            "format":"date-time",
            "nullable":true
        },
        "CampaignName":{
            "title":"Campaign",
            "type":"string",
            "description":"The name of the campaign associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CampaignId"
                ]
            }
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "type":"string",
            "description":"The public unique identifier of business plan associated with the activity.",
            "nullable":true
        },
        "ShowTimeAs":{
            "title":"Show Time As",
            "type":"string",
            "description":"The choice of display of time on your calendar for an activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccountIdAttr":{
            "type":"integer",
            "description":"The unique identifier of the account. This attribute is for internal use.",
            "nullable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when task activity is due to be completed.",
            "format":"date",
            "nullable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"Ithe identifier of the template associated with the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityPartialDescription":{
            "title":"Short Description",
            "maxLength":4000,
            "type":"string",
            "description":"A column that stores the first 4000 characters of activity description.",
            "nullable":true
        },
        "ParentActivityId":{
            "title":"Parent ID",
            "type":"integer",
            "description":"The unique identifier of the related activity ID, only applicable if the record is a follow up activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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 activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ActivityTypeCode"
                ]
            }
        },
        "DirectionCode":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the direction of an activity. The options are inbound/outbound, optional. The default value is null.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TemplateLeadTime":{
            "title":"Lead Time",
            "type":"number",
            "description":"The lead time that is calculated from the activity start date, for the template activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":3
            }
        },
        "CalendarAccess":{
            "type":"boolean",
            "description":"Indicates who has access to the calender.",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarRecurType":{
            "type":"string",
            "description":"The activity recurrence type.",
            "nullable":true
        },
        "SelectedFlag":{
            "type":"boolean",
            "description":"The records selected for Mass Update (Internal Usage).",
            "nullable":true,
            "default":false
        },
        "BuOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The identifier for the business unit. This attribute is obsolete.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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 : schema

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first address line of the service address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address line of the service address.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address line of the service address.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line of the service address.
• AddressSourceCd: string
  Title: Address Source Code

  Maximum Length: 30

  Indicates the source of the service address of the service request. For example, the address source can be account or contact.
• City: string
  Title: City

  Maximum Length: 60

  The city of the service address.
• Country: string
  Title: Country

  Maximum Length: 2

  The country of the service address.
• County: string
  Title: County

  Maximum Length: 60

  The county of the service address.
• LocationId: integer (int64)
  Title: Location ID

  The location that was the source of the service address.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The customer address that was the source of the service address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the service address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the service address.
• ServiceAddressId: integer (int64)
  Title: Service Address ID

  The unique identifier of the service address record.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request associated to the service address.
• State: string
  Title: State

  Maximum Length: 60

  The state of the service address.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 50

  The time zone of the service address.

{
    "type":"object",
    "properties":{
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":50,
            "type":"string",
            "description":"The time zone of the service address.",
            "nullable":true
        },
        "ServiceAddressId":{
            "title":"Service Address ID",
            "type":"integer",
            "description":"The unique identifier of the service address record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The location that was the source of the service address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the service address.",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address line of the service address.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the service address.",
            "nullable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the service address.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the service address.",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the service address.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the service address.",
            "nullable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line of the service address.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the service address.",
            "nullable":true
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The customer address that was the source of the service address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the service address.",
            "nullable":true
        },
        "AddressSourceCd":{
            "title":"Address Source Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the source of the service address of the service request. For example, the address source can be account or contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request associated to the service address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded 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 name of the attachment category.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the type of the data.
• Description: string
  Title: Description

  Maximum Length: 255

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

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• 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 code indicating the type of error, 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 date when the contents in the attachment expire.
• 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 URL of the attachment.
• 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 length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.

{
    "type":"object",
    "properties":{
        "AttachmentsDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-Attachment-AttachmentsDFFVL-item-post-request"
            },
            "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"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachmentsPreview":{
            "title":"Attachments Preview",
            "type":"array",
            "description":"The attachments preview resource is used to preview the attachment pages.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-Attachment-AttachmentsPreview-item-post-request"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"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"
            }
        },
        "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length 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 current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the data.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the 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 URL of the attachment.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of the attachment category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : AttachmentsDFFVL

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-Attachment-AttachmentsDFFVL-item-post-request"
    },
    "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 serviceRequests-Attachment-AttachmentsPreview-item-post-request

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

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• AttachedDocumentId: integer (int64)

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

Nested Schema : serviceRequests-Attachment-AttachmentsPreview-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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 is 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 and the contact point of a person for twitter would be the twitter handle.
• InboundObjectId: integer (int64)
  Title: Inbound Message Object Identifier

  The unique identifier of the inbound object that resulted in the creation of the service request message.
• 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.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the person who is being communicated with.
• PartyViaEndPoint: string
  Title: Party Endpoint

  Maximum Length: 1000

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

  The unique identifier of the person who is a contact on the service request.
• 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.
• 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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "PartyViaEndPoint":{
            "title":"Party Endpoint",
            "maxLength":1000,
            "type":"string",
            "description":"The endpoint used to communicate with the Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ChannelViaEO.PartyViaEndPoint",
                "protectionObjectTitle":"Party Endpoint",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Party Endpoint"
            }
        },
        "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 message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the person who is being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the person who is a contact on the service request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point record of the contact who is 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 and the contact point of a person for twitter would be the twitter handle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChannelShortName":{
            "title":"Channel Short Name",
            "maxLength":450,
            "type":"string",
            "description":"The public unique identifier of the channel.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

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

  Maximum Length: 360

  The name of a service request 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 associated with the contact.
• 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 identification of a person that is a contact on a service request.This is only used for human resource help desk service request.
• PrimaryContactFlag: boolean
  Title: Primary

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

  Maximum Length: 30

  The code indicating the type of 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 public unique number of the a service request.

{
    "type":"object",
    "properties":{
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of 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"
            }
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name associated with the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The service request access level granted to the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the associated service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique number of the a service request.",
            "nullable":false
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false
        }
    }
}

Nested Schema : serviceRequests-messages-item-post-request

Type: object

Show Source

• AILogLevelCd: string
  Title: AI Log Level Code

  Maximum Length: 30

  Default Value: ORA_SVC_NONE

  Indicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.
• channelCommunication: array Channel Communications
  Title: Channel Communications

  The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes 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 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.
• CollabResource: string
  Title: Collaboration Resource

  This field is reserved for internal use only.
• FeedFlag: boolean
  Title: Feed Flag

  Maximum Length: 1

  Default Value: true

  Indicates whether the SR Message should be pushed to the SR Feed. Values are Y and N.
• MessageContent: string (byte)
  Title: Message Content

  The content of the message encoded in base 64 format. Any attachment associated with the message is not the content of the 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

  Indicates 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 last updated date of the message 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 update 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 update 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(required): string
  Title: Message Type Code

  Maximum Length: 30

  The code indicating the message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_TYPE_CD.
• NotificationProcessingStatusCd: string
  Title: Notification Processing Status Code

  Maximum Length: 30

  The code indicating the status of the response notification. For example, Error, Success. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD.
• NotificationRetryCount: integer (int32)
  Title: Notification Retry Count

  The number of times the system tried to send the SR message notification.
• ObjectId(required): 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 Code

  Maximum Length: 30

  Default Value: SVC_SR_MESSAGES

  This field is reserved for internal use only.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The 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 service request message.
• 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.
• PrivateInformationFlag: boolean
  Title: Contains PII Data

  Maximum Length: 1

  Indicates whether the message contains personally identifiable information.
• ProcessingStatusCd: string
  Title: Processing Status

  Maximum Length: 30

  Default Value: ORA_SVC_READY

  The code indicating the processing status of the message. The accepted values are Ready, Processing, Error, and Success.A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD .
• 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.
• SentDate: string (date-time)
  Title: Sent Date

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

  Maximum Length: 1

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

  Maximum Length: 30

  The code indicating the source of the message. For example, Agent UI, Customer UI, and API. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD.
• SrId(required): 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(required): string
  Title: Service Request Number

  Maximum Length: 30

  The public unique number of the a service request.
• StatusCd(required): string
  Title: Status Code

  Maximum Length: 30

  The code indicating 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 used to send an email response to a customer.
• VisibilityCd: string
  Title: Visibility Code

  Maximum Length: 30

  The code indicating the privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_VISIBILITY_CD.

{
    "required":[
        "MessageTypeCd",
        "ObjectId",
        "SocialPrivateFlag",
        "SrId",
        "SrNumber",
        "StatusCd"
    ],
    "type":"object",
    "properties":{
        "MessageContent":{
            "title":"Message Content",
            "type":"string",
            "description":"The content of the message encoded in base 64 format. Any attachment associated with the message is not the content of the message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"SrMessageEO.MessageContent",
                "protectionObjectTitle":"Message Content",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Message Content"
            }
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request message.",
            "nullable":false
        },
        "NotificationProcessingStatusCd":{
            "title":"Notification Processing Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the response notification. For example, Error, Success. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD.",
            "nullable":true
        },
        "PrivateInformationFlag":{
            "title":"Contains PII Data",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the message contains personally identifiable information.",
            "nullable":true
        },
        "VisibilityCd":{
            "title":"Visibility Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.  A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_VISIBILITY_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MessageTypeCd":{
            "title":"Message Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. A list of accepted values is defined in the lookup  \nORA_SVC_MESSAGE_TYPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date and time when the message was sent.",
            "format":"date-time",
            "nullable":true
        },
        "MessageLastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last updated date of the message in the original source system. This is applicable if the service request message was imported from another system.",
            "format":"date-time",
            "nullable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-Attachment-item-post-request"
            }
        },
        "ChannelId":{
            "title":"Channel",
            "type":"string",
            "description":"The unique identifier of the channel.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ChannelTypeCd"
                ]
            }
        },
        "MessageExpandingState":{
            "title":"Message Expand State",
            "type":"integer",
            "description":"Indicates the message expanding state.",
            "nullable":true
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the source of the message. For example, Agent UI, Customer UI, and API. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CollabResource":{
            "title":"Collaboration Resource",
            "type":"string",
            "description":"This field is reserved for internal use only.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProcessingStatusCd":{
            "title":"Processing Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the processing status of the message. The accepted values are Ready, Processing, Error, and Success.A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD .",
            "nullable":true,
            "default":"ORA_SVC_READY"
        },
        "MessageLastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last update 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"
                ]
            }
        },
        "ObjectTypeCd":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"This field is reserved for internal use only.",
            "nullable":false,
            "default":"SVC_SR_MESSAGES"
        },
        "MessageSubTypeCd":{
            "title":"Message Subtype",
            "maxLength":30,
            "type":"string",
            "description":"The service request message subtype.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "TemplateName":{
            "title":"Template Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the template used to send an email response to a customer.",
            "nullable":true
        },
        "channelCommunication":{
            "title":"Channel Communications",
            "type":"array",
            "description":"The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-channelCommunication-item-post-request"
            }
        },
        "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
            }
        },
        "SocialPrivateFlag":{
            "title":"Private Message",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the message was created from a private social post.",
            "nullable":false
        },
        "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
            }
        },
        "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
            }
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the message. The accepted values are Draft, Committed, and Corrected.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The 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
        },
        "FeedFlag":{
            "title":"Feed Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the SR Message should be pushed to the SR Feed. Values are Y and N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ParentMessageId":{
            "title":"Parent Message ID",
            "type":"integer",
            "description":"The unique identifier of the parent service request message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique number of the a service request.",
            "nullable":false
        },
        "NotificationRetryCount":{
            "title":"Notification Retry Count",
            "type":"integer",
            "description":"The number of times the system tried to send the SR message notification.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            }
        },
        "Subject":{
            "title":"Subject",
            "maxLength":1000,
            "type":"string",
            "description":"The subject of the service request message.",
            "nullable":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"
                ]
            }
        },
        "AILogLevelCd":{
            "title":"AI Log Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE.",
            "nullable":false,
            "default":"ORA_SVC_NONE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MessageLastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last update 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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "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
        },
        "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":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
            }
        },
        "SrInlineAttachmentIds":{
            "title":"Inline Attachment Identifiers",
            "maxLength":1000,
            "type":"string",
            "description":"The list of inline attachment identifiers associated with the service request",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-messages-Attachment-item-post-request"
    }
}

Nested Schema : Channel Communications

Type: array

Title: Channel Communications

The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.

Show Source

• Array of: object schema

{
    "title":"Channel Communications",
    "type":"array",
    "description":"The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-messages-channelCommunication-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded 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 name of the attachment category.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the type of the data.
• Description: string
  Title: Description

  Maximum Length: 255

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

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• 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 code indicating the type of error, 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 date when the contents in the attachment expire.
• 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 URL of the attachment.
• 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 length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.

{
    "type":"object",
    "properties":{
        "AttachmentsDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-Attachment-AttachmentsDFFVL-item-post-request"
            },
            "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"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachmentsPreview":{
            "title":"Attachments Preview",
            "type":"array",
            "description":"The attachments preview resource is used to preview the attachment pages.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-Attachment-AttachmentsPreview-item-post-request"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"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"
            }
        },
        "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length 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 current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the data.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the 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 URL of the attachment.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of the attachment category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : AttachmentsDFFVL

Type: array

Show Source

• Array of: object serviceRequests-messages-Attachment-AttachmentsDFFVL-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-messages-Attachment-AttachmentsDFFVL-item-post-request"
    },
    "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 serviceRequests-messages-Attachment-AttachmentsPreview-item-post-request

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

Nested Schema : serviceRequests-messages-Attachment-AttachmentsDFFVL-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• AttachedDocumentId: integer (int64)

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

Nested Schema : serviceRequests-messages-Attachment-AttachmentsPreview-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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 is 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 and the contact point of a person for twitter would be the twitter handle.
• InboundObjectId: integer (int64)
  Title: Inbound Message Object Identifier

  The unique identifier of the inbound object that resulted in the creation of the service request message.
• 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.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the person who is being communicated with.
• PartyViaEndPoint: string
  Title: Party Endpoint

  Maximum Length: 1000

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

  The unique identifier of the person who is a contact on the service request.
• 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.
• 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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "PartyViaEndPoint":{
            "title":"Party Endpoint",
            "maxLength":1000,
            "type":"string",
            "description":"The endpoint used to communicate with the Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ChannelViaEO.PartyViaEndPoint",
                "protectionObjectTitle":"Party Endpoint",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Party Endpoint"
            }
        },
        "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 message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the person who is being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the person who is a contact on the service request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point record of the contact who is 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 and the contact point of a person for twitter would be the twitter handle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChannelShortName":{
            "title":"Channel Short Name",
            "maxLength":450,
            "type":"string",
            "description":"The public unique identifier of the channel.",
            "nullable":false
        }
    }
}

Nested Schema : serviceRequests-resourceMembers-item-post-request

Type: object

Show Source

• MemberId: integer (int64)
  Title: Member ID

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

  The unique identifier of the individual resource added as service request resource member.
• OwnerFlag: boolean
  Title: Assigned To

  Indicates if the service request is assigned to the resource member. If yes, the value is True, else the value is False.
• ResourceName: string
  Title: Name

  Maximum Length: 360

  The name of the individual resource added as service request resource member.
• SrId: integer (int64)
  Title: Service Request ID

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

  Maximum Length: 30

  The public unique identifier of the service request number.

{
    "type":"object",
    "properties":{
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"A unique identifier service request resource member record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectId":{
            "title":"Service Request Team Member Resource ID",
            "type":"integer",
            "description":"The unique identifier of the individual resource added as service request resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the individual resource added as service request resource member.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OwnerFlag":{
            "title":"Assigned To",
            "type":"boolean",
            "description":"Indicates if 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"
                ]
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request that the resource is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request number.",
            "nullable":false
        }
    }
}

Nested Schema : serviceRequests-smartActions-item-post-request

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

  The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The media type of the smart action REST operation.
• DisplayLabel(required): string
  Title: Action Name

  Maximum Length: 256

  The display name of the smart action.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The relative path of the smart action REST resource. The path can include path parameters.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The client applications that the smart action is associated with.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Indicates whether an action is designed to operate on multiple object instances selected by an end user.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function for 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 whether the action is smart suggest enabled.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the smart action definition.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The unique identifier of the smart action name.
• 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

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• 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.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action is smart suggest enabled.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-smartActions-UserActionURLBinding-item-post-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an action is designed to operate on multiple object instances selected by an end user.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-smartActions-UserActionNavigation-item-post-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The unique identifier of the smart action name.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":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/serviceRequests-smartActions-UserActionRequestPayload-item-post-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "nullable":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
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function for smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        }
    }
}

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 serviceRequests-smartActions-UserActionNavigation-item-post-request

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

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 serviceRequests-smartActions-UserActionRequestPayload-item-post-request

{
    "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/serviceRequests-smartActions-UserActionRequestPayload-item-post-request"
    }
}

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 serviceRequests-smartActions-UserActionURLBinding-item-post-request

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

Nested Schema : serviceRequests-smartActions-UserActionNavigation-item-post-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false
        }
    }
}

Nested Schema : serviceRequests-smartActions-UserActionRequestPayload-item-post-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• 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

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true
        }
    }
}

Nested Schema : serviceRequests-smartActions-UserActionURLBinding-item-post-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        }
    }
}

Nested Schema : serviceRequests-srInteractionReferences-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : serviceRequests-srMilestone-item-post-request

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates that the milestone is active.
• AgentCompletedFlag: boolean
  Title: Agent Completed

  Maximum Length: 1

  Default Value: false

  Indicates whether agent marked the milestone as complete.
• Comments: string
  Title: Comments

  Maximum Length: 400

  The comments the agent made about the milestone. For example, why the due date was overridden.
• CompletionDate: string (date-time)
  Title: Completion Date

  The date when the milestone was completed.
• ComplianceFlag: boolean
  Title: Compliance

  Maximum Length: 1

  Default Value: true

  Indicates whether the milestone is compliant or not. The default value is true.
• CoverageId(required): integer (int64)
  Title: Coverage ID

  The unique identifier of the service request coverage.
• CoverageSourceCd: string
  Title: Coverage Source

  Maximum Length: 120

  Coverage Source
• DelayTime: integer (int64)
  Title: Delay Time

  The amount of time the milestones has been delayed from the due date.
• DueDate: string (date-time)
  Title: Due Date

  The date when the milestone is due.
• EntitlementId: integer
  The unique identifier of the entitlement for the milestone.
• MilestoneConfigId(required): integer (int64)
  Title: Milestone Configuration ID

  The unique identifier of the milestone configuration.
• MilestoneStatusCd(required): string
  Title: Status

  Maximum Length: 30

  The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.
• SrAssigneePartyId: integer
  Title: Assigned to Party ID

  The unique identifier of the resource assigned to the service request.
• SrId(required): integer (int64)
  Title: Service Request ID

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

  The list of changes in the service request milestone status.
• 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 to complete the milestone after the service request is restored from a paused state.
• WarnedFlag: boolean
  Title: Warned

  Maximum Length: 1

  Default Value: false

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

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

{
    "required":[
        "CoverageId",
        "MilestoneConfigId",
        "MilestoneStatusCd",
        "SrId"
    ],
    "type":"object",
    "properties":{
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WarnedFlag":{
            "title":"Warned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone has passed the warning threshold.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Number",
            "nullable":true
        },
        "SrAssigneePartyId":{
            "title":"Assigned to Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource assigned to the service request.",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The comments the agent made about the milestone. For example, why the due date was overridden.",
            "nullable":true
        },
        "EntitlementId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement for the milestone.",
            "nullable":true,
            "x-queryable":false
        },
        "TimeLeftOnceUnpaused":{
            "title":"Paused Minutes Remaining",
            "type":"integer",
            "description":"The time left to complete the milestone after the service request is restored from a paused state.",
            "nullable":true
        },
        "DelayTime":{
            "title":"Delay Time",
            "type":"integer",
            "description":"The amount of time the milestones has been delayed from the due date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SrMilestoneHistory":{
            "title":"Milestones History",
            "type":"array",
            "description":"The list of changes in the service request milestone status.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srMilestone-SrMilestoneHistory-item-post-request"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the milestone is active.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the service request coverage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CoverageSourceCd":{
            "title":"Coverage Source",
            "maxLength":120,
            "type":"string",
            "description":"Coverage Source",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MilestoneConfigId":{
            "title":"Milestone Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the milestone configuration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when the milestone is due.",
            "format":"date-time",
            "nullable":true
        },
        "WarningDate":{
            "title":"Warning Date",
            "type":"string",
            "description":"The date and time when the milestone passed the warning threshold.",
            "format":"date-time",
            "nullable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date when the milestone was completed.",
            "format":"date-time",
            "nullable":true
        },
        "ComplianceFlag":{
            "title":"Compliance",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone is compliant or not. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "SubscriptionCoveragePuid":{
            "title":"Subscription Coverage PUID",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Coverage PUID",
            "nullable":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"
            }
        }
    }
}

Nested Schema : Milestones History

Type: array

Title: Milestones History

The list of changes in the service request milestone status.

Show Source

• Array of: object serviceRequests-srMilestone-SrMilestoneHistory-item-post-request

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

Nested Schema : serviceRequests-srMilestone-SrMilestoneHistory-item-post-request

Type: object

Show Source

• AccumulatedTimeInStatus: integer (int64)
  Title: Accumulated Time

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

  Maximum Length: 400

  The comments the agent made about the milestone. For example, why the due date was overridden.
• EndTime: string (date-time)
  The date and time when the milestone exited the status.
• MilestoneStatusCd: string
  Title: Status

  Maximum Length: 30

  The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.
• OverriddenDueDate: string (date-time)
  Title: Due Date

  Indicates the new due date the agent set for the milestone.
• SrMilestoneId: integer (int64)
  Title: Milestone ID

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

  The date and time when the milestone status was changed.

{
    "type":"object",
    "properties":{
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndTime":{
            "type":"string",
            "description":"The date and time when the milestone exited the status.",
            "format":"date-time",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The comments the agent made about the milestone. For example, why the due date was overridden.",
            "nullable":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
            }
        },
        "StartTime":{
            "title":"Date",
            "type":"string",
            "description":"The date and time when the milestone status was changed.",
            "format":"date-time",
            "nullable":false
        },
        "OverriddenDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Indicates the new due date the agent set for the milestone.",
            "format":"date-time",
            "nullable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the service request milestone.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ArticleId: string
  Title: Article ID

  Maximum Length: 64

  The unique identifier of the Oracle Knowledge Cloud Service article.
• ArticleLocale: string
  Title: Article Locale

  Maximum Length: 10

  The locale of the document, such as en_US. This attribute is valid only when ArticleId is populated.
• HelpfulFlag: boolean
  Title: Helpful

  Maximum Length: 1

  Indicates whether the service request reference was helpful.
• LinkedFlag: boolean
  Title: Linked

  Maximum Length: 1

  Indicates whether the reference is linked with the service request.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object referencing the service request (SR), or referenced by the SR, such as Note, Defect, or another SR.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The code indicating the type of the object that the service request reference is associated with such as Note, Article, Defect, Other SR. A list of accepted values is defined in the lookup ORA_SVC_SR_REF_OBJECT_TYPE_CD.
• RelationTypeCd: string
  Title: Relation Type

  Maximum Length: 30

  The type of relationship.
• ResolutionCd: string
  Title: Resolution Code

  Maximum Length: 30

  The code indicating the resolution code of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.
• 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 to which the reference is associated.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The public unique identifier of the service request.
• Subject: string
  Title: Title

  Maximum Length: 1000

  The title of the article. This attribute is valid only when ArticleId is populated.

{
    "type":"object",
    "properties":{
        "SharedFlag":{
            "title":"Shared",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request reference is shared with the customer.",
            "nullable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object referencing the service request (SR), or referenced by the SR, such as Note, Defect, or another SR.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelationTypeCd":{
            "title":"Relation Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of relationship.",
            "nullable":true
        },
        "HelpfulFlag":{
            "title":"Helpful",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request reference was helpful.",
            "nullable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request.",
            "nullable":false
        },
        "Subject":{
            "title":"Title",
            "maxLength":1000,
            "type":"string",
            "description":"The title of the article. This attribute is valid only when ArticleId is populated.",
            "nullable":true
        },
        "LinkedFlag":{
            "title":"Linked",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the reference is linked with the service request.",
            "nullable":true
        },
        "ArticleLocale":{
            "title":"Article Locale",
            "maxLength":10,
            "type":"string",
            "description":"The locale of the document, such as en_US. This attribute is valid only when ArticleId is populated.",
            "nullable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the object that the service request reference is associated with such as Note, Article, Defect, Other SR. A list of accepted values is defined in the lookup ORA_SVC_SR_REF_OBJECT_TYPE_CD.",
            "nullable":false
        },
        "ArticleId":{
            "title":"Article ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Oracle Knowledge Cloud Service article.",
            "nullable":true
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the resolution code of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request to which the reference is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The unique identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Tag":{
            "maxLength":64,
            "type":"string",
            "description":"The value of the tag associated with a service request.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AccountPartyEmailAddress: string
  Title: Account Party Email Address

  Read Only: true

  Maximum Length: 320

  The e-mail address of the account on the service request.
• AccountPartyFormattedPhoneNumber: string
  Title: Account Party Formatted Phone Number

  Read Only: true

  The formatted phone number of the account on the service request.
• AccountPartyId: integer (int64)
  Title: Account ID

  The unique identifier of the account party associated with the service request.
• AccountPartyName: string
  Title: Account Name

  Read Only: true

  Maximum Length: 360

  The name of the account party.
• AccountPartyNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the account associated with the service request.
• AccountPartyPreferredContactMethod: string
  Title: Account Party Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred contact method of the account on the service request.
• AccountPartyUniqueName: string
  Title: Account

  Maximum Length: 900

  The unique name to identify the account.
• activities: array Activities
  Title: Activities

  The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.
• addresses: array Service Addresses
  Title: Service Addresses

  A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.
• 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 person on the service request. This field is only applicable for the human resource help desk application.
• AffectedPartyPersonName: string
  Title: Affected Party Person Name

  Read Only: true

  The display name of the affected party person in the service request.
• AssetId: integer (int64)
  Title: Asset

  The unique identifier of the asset associated with the service request.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 100

  The asset number associated with the service request.
• AssetSerialNumber: string
  Title: Asset Serial Number

  Read Only: true

  Maximum Length: 100

  The serial number of the asset that is associated with 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 service request 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 party object associated with the service request assignee.
• AssigneePersonName: string
  Title: Assigned To

  Maximum Length: 360

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

  The foreign key of the party object associated with the service request assignee.
• AssigneeResourceNumber: string
  Title: Assigned to Resource Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the assignee of the service request.
• AssigneeTimezone: string
  Title: Assignee Time Zone

  Read Only: true

  Maximum Length: 255

  The time zone of the assignee associated with the service request.
• AssistedByHumanFlag: boolean
  Title: Assisted by Human Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether human agents worked on the service request at any stage of its lifecycle.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.
• BillToCustomerAccountDescription: string
  Title: Bill-To Customer Account Description

  Read Only: true

  Maximum Length: 240

  The description of the customer account to be billed for work performed on the service request.
• BillToCustomerAccountId: integer (int64)
  Title: Bill to Customer Account ID

  The customer account to be billed for work performed on the service request.
• BillToCustomerAccountNumber: string
  Title: Bill-To Customer Account Number

  Read Only: true

  Maximum Length: 30

  The PUID for the customer account to be billed for work performed on the service request.
• BillToCustomerAccountSiteId: integer (int64)
  Title: Bill to Customer Account Site ID

  The customer account site to be billed for work performed on the service request.
• BillToCustomerAccountSiteUsageNumber: string
  Title: Bill-To Customer Account Site Usage Number

  Maximum Length: 255

  The PUID for the customer account site bill-to usage.
• BillToCustomerId: integer (int64)
  Title: Bill to Customer ID

  The customer to be billed for work performed on the service request.
• BillToCustomerName: string
  Title: Bill-To Customer Name

  Read Only: true

  Maximum Length: 360

  The name of the customer to be billed for work performed on the service request.
• BillToCustomerNumber: string
  Title: Bill-To Customer Number

  Read Only: true

  Maximum Length: 30

  The PUID for the customer to be billed for work performed on the service request.
• BillToPartySiteFormattedAddress: string
  Title: Bill-To Party Site Formatted Address

  Maximum Length: 5000

  The formatted address for the customer site to be billed for work performed on the service request.
• BillToPartySiteId: integer (int64)
  Title: Bill-To Party Site ID

  The address of the customer site to be billed for work performed on the service request.
• BillToPartySiteLocationId: integer (int64)
  Title: Bill-To Party Site Location ID

  Read Only: true

  The location of the customer site to be billed for work performed on the service request.
• BillToPartySiteName: string
  Title: Bill-To Party Site Name

  Read Only: true

  Maximum Length: 240

  The name of the customer site to be billed for work performed on the service request.
• BillToPartySiteNumber: string
  Title: Bill-To Party Site Number

  Read Only: true

  Maximum Length: 30

  The PUID for the customer site to be billed for work performed on the service request.
• BUOrgId: integer (int64)
  Title: Business Unit

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

  Read Only: true

  Maximum Length: 255

  The name of the business unit associated with the service request.
• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case associated with the service request.
• CaseNumber: string
  Title: Case Number

  Maximum Length: 255

  The public unique identifier of the case associated with the service request.
• CategoryCode: string
  Title: Category Code

  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 with the service request.
• channelCommunication: array Channel Communications
  Title: Channel Communications

  The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes 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 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.
• ChannelTypeCdMeaning: string
  Title: Channel Type Value

  Read Only: true

  Maximum Length: 255

  The display value of the channel type lookup code for the service request, such as Chat, Phone, or Email.
• ClosedDate: string (date-time)
  Title: Date Closed

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

  Read Only: true

  Maximum Length: 1

  Indicates whether the milestone is compliant or not. The default value is true.
• contacts: array Contact Members
  Title: Contact Members

  The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• 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 currency conversion rate type associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup RatedCurrenciesVA.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether a service request is deleted and not to be displayed in the UI. The default value is false.
• 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.
• HandledByAIFlag: boolean
  Title: Handled by AI Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether automation agents acted upon the service request at any point in its lifecycle.
• HeaderFlag: boolean
  Title: Header

  Read Only: true

  Maximum Length: 1

  Indicates whether the milestone is a service request header milestone or not.
• IBAssetDescription: string
  Title: Installed Base Asset Description

  Read Only: true

  Maximum Length: 240

  The description of the installed base asset associated with the service request.
• IBAssetId: integer (int64)
  Title: Installed Base Asset ID

  The unique identifier of the install base asset associated with the service request.
• IBAssetLocation: string
  Title: Installed Base Asset Location

  Maximum Length: 5000

  The location address of the installed base asset associated with the service request.
• IBAssetLocationType: string
  Title: Installed Base Asset Location Type

  Read Only: true

  Maximum Length: 80

  The location type of the installed base asset associated with the service request.
• IBAssetNumber: string
  Title: Installed Base Asset Number

  Read Only: true

  Maximum Length: 80

  The installed base asset number associated with the service request.
• IBAssetSerialNumber: string
  Title: Installed Base Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the install base asset associated with the service request.
• InternalPriorityCd: string
  Title: Internal Priority Code

  Maximum Length: 30

  The code indicating the internal priority of the service request. For example, High, Normal, Low, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_INT_PRIORITY_CD.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

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

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

  Maximum Length: 30

  The code indicating the customer's preferred language for the service request. For example, en, fr, and so on.
• 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 last 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 update 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)
  Title: Last Updated by Party ID

  The unique identifier of the party of the user who last updated the service request.
• LastUpdatedByPartyNumber: string
  Title: Last Updated by Party Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the person who last updated the service request.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

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

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

  The unique identifier of the loyalty member associated with the customer contact.
• LoyMemberName: string
  Title: Loyalty Member

  Maximum Length: 100

  The name of the loyalty member associated with the customer contact.
• LoyMemberNumber: string
  Title: Loyalty Member Number

  Read Only: true

  Maximum Length: 30

  The public unique loyalty member identifier of the service request primary contact.
• messages: array Messages
  Title: Messages

  The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".
• MilestoneConfigId: integer (int64)
  Title: Configuration ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Maximum Length: 255

  The code indicating the status of the milestone. For example, In Progress, Complete. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.
• 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.
• OpenDate: string (date-time)
  Title: Date Reported

  The date when the service request was reported by the customer. Typically, the value is the same as Creation Date. However, if the service request was migrated from another system then the Creation Date is the date the SR was created and Date Reported is the date the customer reported the service request.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

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

  Maximum Length: 30

  The code indicating the type of the service request owner. For example, a customer or a partner.
• PartnerAccountPartyId: integer (int64)
  Title: Partner Account Party ID

  The unique identifier of the partner account party.
• PartnerAccountPartyName: string
  Title: Partner Account

  Maximum Length: 360

  The name of the partner account party. Two accounts can have the same party name but not the same unique name.
• PartnerAccountPartyNumber: string
  Title: Partner Account Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the partner account associated with the service request.
• PartnerAccountPartyUniqueName: string
  Title: Partner Account

  Maximum Length: 900

  The unique name to identify the partner account.
• 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

  Indicates that the primary contact of the service request does not want to be contacted. The default value is false.
• PrimaryContactEmailAddress: string
  Title: Primary Contact Email

  Read Only: true

  Maximum Length: 320

  The e-mail address 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 phone number of the primary contact.
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact ID

  The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request.
• PrimaryContactPartyName: string
  Title: Primary Contact

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the primary contact associated of the service request.
• PrimaryContactPartyUniqueName: string
  Title: Primary Contact Unique Name

  Maximum Length: 900

  The unique party name associated with the primary contact.
• PrimaryContactPersonId: integer (int64)
  Title: Primary Contact Person ID

  The identifier of the primary contact person of the service request. This field is only applicable for the human resource help desk application.
• 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 code indicating the problem with a service request. A list of accepted values is defined in the lookup: ORA_SVC_SR_PROBLEM_TYPE_CD. For example, ORA_SVC_DOCS, ORA_SVC_PRODUCT.
• ProblemDescription: string
  Title: Problem Description

  Maximum Length: 1000

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

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

  Maximum Length: 255

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

  The public unique identifier of the product associated with the service request.
• ProductItemDescription: string
  Title: Product Description

  Maximum Length: 255

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

  Read Only: true

  Maximum Length: 255

  The alternate key identifier of the product associated with the service request.
• ProductItemOrgId: integer (int64)
  Title: Product Organization

  Read Only: true

  The unique identifier of the organization of the product that is associated with the service request.
• PurchaseOrder: string
  Title: Purchase Order

  Maximum Length: 50

  The purchase order associated with the service request.
• 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 with the service request.
• QueueNumber: string
  Title: Queue Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the service request queue.
• RecordSet: string
  Title: Search Filter

  Read Only: true

  The record set selected by the user. The selected record set is used to filter the search results.
• 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 service request in the system.
• ReportedByPartyName: string
  Title: Reported By

  Read Only: true

  Maximum Length: 360

  The person who reported the service request.
• ReportedByPartyNumber: string
  Title: Reported by Party Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the person who reported 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 code indicating the type of resolution of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.
• ResolutionCdMeaning: string
  Title: Resolution Value

  Read Only: true

  The display value of the resolution lookup code for the service request, such as Satisfied.
• ResolvedBy: string
  Title: Resolved By

  Maximum Length: 64

  The name of the person who initiated the resolution process.
• ResolvedByAIFlag: boolean
  Title: Resolved by AI Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether the service request was resolved with the assistance of automation agents.
• ResolvedByPartyId: integer (int64)
  Title: Resolved by Party ID

  The unique identifier of the user who resolved this service request.
• ResolveDescription: string
  Title: Solution Description

  Maximum Length: 1000

  A brief description of how the problem was resolved.
• ResolveOutcomeCd: string
  Title: Outcome

  Maximum Length: 30

  The code indicating the type of resolution that was achieved for the Service Request.
• ResolveOutcomeCdMeaning: string
  Title: Outcome Value

  Read Only: true

  The display value of the resolution outcome lookup code for the service request, such as Solution Provided.
• resourceMembers: array Resources
  Title: Resources

  Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.
• ScheduleId: integer (int64)
  Title: Schedule Identifier

  The unique identifier of the current schedule associated with the service request.
• ServiceProfileId: integer (int64)
  Title: Service Profile ID

  The service profile associated with the service request.
• ServiceProfileName: string
  Title: Service Profile Name

  Read Only: true

  Maximum Length: 400

  The name of the service profile associated with the service request.
• ServiceProfileNumber: string
  Title: Service Profile Number

  Read Only: true

  Maximum Length: 30

  The PUID for the service profile associated with the service request.
• ServiceProfilePartySiteId: integer (int64)
  Title: Service Profile Site ID

  Read Only: true

  The address of the service profile associated with the service request.
• ServiceProfilePartySiteLocationId: integer (int64)
  Title: Service Profile Site Location ID

  Read Only: true

  The location of the service profile associated with the service request.
• ServiceProfilePartySiteName: string
  Title: Service Profile Site Party Name

  Read Only: true

  Maximum Length: 240

  The name of the address of the service profile associated with the service request.
• ServiceProfilePartySiteNumber: string
  Title: Service Profile Site Party Number

  Read Only: true

  Maximum Length: 30

  The PUID of the address of the service profile associated with the service request.
• ServiceProfileSiteFormattedAddress: string
  Title: Service Profile Formatted Address

  Maximum Length: 5000

  The formatted address of the service profile associated with 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 code indicating the severity of the service request. For example, Sev1, Sev2, Sev3, and Sev4.
• SeverityCdMeaning: string
  Title: Severity Value

  Read Only: true

  The display value of the severity lookup code for the service request, such as High.
• SeverityColorCd: string
  Title: Severity Color Code

  Read Only: true

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

  Read Only: true

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

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• SocialPrivateFlag: boolean
  Title: Private Social Post

  Maximum Length: 1

  Default Value: false

  Indicates if the service request was created from a private social post. The default value is false.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  The code indicating how the service request was created in the application. For example, Agent_UI, Customer_UI, API, and so on. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD .
• 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

  The interaction references resource is used to view the relationship between an interaction and 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. It defaults to LAST_UPDATED_BY if null, or for migration, set to the user who last updated the row.
• SrLastUpdatedByPartyId: integer (int64)
  Title: Source System SR Last Updated By

  The unique identifier of the user who last updated the service request.
• SrLastUpdatedByPartyName: string
  Title: Source System SR Last Updated by Party Name

  Read Only: true

  Maximum Length: 360

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

  Maximum Length: 32

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

  The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.
• SrMilestoneId: integer (int64)
  Title: Milestone ID

  Read Only: true

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

  Maximum Length: 30

  The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
• srReferences: array Service Request References
  Title: Service Request References

  The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.
• srTags: array Tags
  Title: Tags

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

  Maximum Length: 30

  The code indicating the status of the service request. For example, New, InProgress, Waiting, Resolved, Closed, and so on.
• StatusCdMeaning: string
  Title: Status Value

  Read Only: true

  The display value of the status lookup code for the service request, such as New, or In-Progress.
• StatusTypeCd: string
  Title: Status Type

  Read Only: true

  Maximum Length: 30

  The code indicating the status type of the service request. The possible values are, New, In Progress, Waiting, Resolved, and Closed.
• StatusTypeCdMeaning: string
  Title: Status Type Value

  Read Only: true

  The display value of the status type lookup code for the service request, such as New, or Resolved.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  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 to the survey vendor.
• 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: Title

  Maximum Length: 400

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

  Default Value: 0

  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 if the service request has been updated.
• WarnedFlag: boolean
  Title: Warned

  Read Only: true

  Maximum Length: 1

  Indicates that 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":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProdGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group associated with 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",
            "maxLength":255,
            "type":"string",
            "description":"The name of the product group associated with the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProblemDescription":{
            "title":"Problem Description",
            "maxLength":1000,
            "type":"string",
            "description":"The service request's problem description/statement and the steps to reproduce the issue.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ServiceRequestEO.ProblemDescription",
                "protectionObjectTitle":"Problem Description",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Problem Description"
            },
            "x-queryable":true
        },
        "ProductItemDescription":{
            "title":"Product Description",
            "maxLength":255,
            "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 currency conversion rate type associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the service request was created in the application. For example, Agent_UI, Customer_UI, API, and so on. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD .",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup RatedCurrenciesVA.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProfilePartySiteLocationId":{
            "title":"Service Profile Site Location ID",
            "type":"integer",
            "description":"The location of the service profile associated with the service request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HeaderFlag":{
            "title":"Header",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone is a service request header milestone or not.",
            "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
        },
        "IBAssetId":{
            "title":"Installed Base Asset ID",
            "type":"integer",
            "description":"The unique identifier of the install base asset associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryContactEmailAddress":{
            "title":"Primary Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address 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"
            }
        },
        "SrLastUpdatedByPartyId":{
            "title":"Source System SR Last Updated By",
            "type":"integer",
            "description":"The unique identifier of the user who last updated the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IBAssetLocationType":{
            "title":"Installed Base Asset Location Type",
            "maxLength":80,
            "type":"string",
            "description":"The location type of the installed base asset associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account party associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact who initially reported the service request. The contact is also 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 code indicating the type of the service request owner. For example, a customer or a partner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SeverityColorCd":{
            "title":"Severity Color Code",
            "type":"string",
            "description":"The code indicating the color code for the service request severity.",
            "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 of the status lookup code for the service request, such as New, or In-Progress.",
            "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 with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryContactPersonId":{
            "title":"Primary Contact Person ID",
            "type":"integer",
            "description":"The identifier of the primary contact person of the service request. This field is only applicable for the human resource help desk application.",
            "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 to the survey vendor.",
            "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 is associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToCustomerNumber":{
            "title":"Bill-To Customer Number",
            "maxLength":30,
            "type":"string",
            "description":"The PUID for the customer to be billed for work performed on the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether a service request is deleted and not to be displayed in the UI. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the primary contact associated of the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyName":{
            "title":"Account Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneePersonName":{
            "title":"Assigned To",
            "maxLength":360,
            "type":"string",
            "description":"The name of the assignee.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "messages":{
            "title":"Messages",
            "type":"array",
            "description":"The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, \"We have credited your account for the value of the call. You should see a credit in your next monthly bill.\" or  \"We have notified the billing department about the issue. This issue should not recur.\".",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-item-response"
            }
        },
        "ServiceProfilePartySiteName":{
            "title":"Service Profile Site Party Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the address of the service profile associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneConfigId":{
            "title":"Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the milestone configuration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssistedByHumanFlag":{
            "title":"Assisted by Human Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether human agents worked on the service request at any stage of its lifecycle.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ComplianceFlag":{
            "title":"Compliance",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone is compliant or not. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset",
            "type":"integer",
            "description":"The unique identifier of the asset associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The application login id of the user who last updated the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IBAssetSerialNumber":{
            "title":"Installed Base Asset Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"The serial number of the install base asset associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToCustomerId":{
            "title":"Bill to Customer ID",
            "type":"integer",
            "description":"The customer to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "srReferences":{
            "title":"Service Request References",
            "type":"array",
            "description":"The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srReferences-item-response"
            }
        },
        "AccountPartyFormattedPhoneNumber":{
            "title":"Account Party Formatted Phone Number",
            "type":"string",
            "description":"The formatted phone number of the account on the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AccountPartyPrimaryPhoneAreaCode",
                    "AccountPartyPrimaryPhoneContactPtId",
                    "AccountPartyPrimaryPhoneCountryCode",
                    "AccountPartyPrimaryPhoneExtension",
                    "AccountPartyPrimaryPhoneLineType",
                    "AccountPartyPrimaryPhoneNumber"
                ]
            }
        },
        "ServiceProfileSiteFormattedAddress":{
            "title":"Service Profile Formatted Address",
            "maxLength":5000,
            "type":"string",
            "description":"The formatted address of the service profile associated with the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":900,
            "type":"string",
            "description":"The unique name to identify the account.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AssigneeResourceId":{
            "title":"Assigned to Resource ID",
            "type":"integer",
            "description":"The foreign key of the party object associated with the service request assignee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "resourceMembers":{
            "title":"Resources",
            "type":"array",
            "description":"Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-resourceMembers-item-response"
            }
        },
        "ResolveOutcomeCd":{
            "title":"Outcome",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of resolution that was achieved for the Service Request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the account associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the milestone associated with the service request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceProfilePartySiteId":{
            "title":"Service Profile Site ID",
            "type":"integer",
            "description":"The address of the service profile associated with 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 service request assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AssigneeIdenAddrLocationId",
                    "AssigneeCountry",
                    "AssigneePersonalAddressFlag"
                ]
            }
        },
        "IBAssetDescription":{
            "title":"Installed Base Asset Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the installed base asset associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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. It defaults to LAST_UPDATED_BY if null, or for migration, set to the user who last updated the row.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdatedBy"
                ]
            }
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":255,
            "type":"string",
            "description":"The public unique identifier of the case associated with the service request.",
            "nullable":true,
            "x-queryable":false
        },
        "channelCommunication":{
            "title":"Channel Communications",
            "type":"array",
            "description":"The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-channelCommunication-item-response"
            }
        },
        "PartnerAccountPartyId":{
            "title":"Partner Account Party ID",
            "type":"integer",
            "description":"The unique identifier of the partner account party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IBAssetNumber":{
            "title":"Installed Base Asset Number",
            "maxLength":80,
            "type":"string",
            "description":"The installed base asset number associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProfileId":{
            "title":"Service Profile ID",
            "type":"integer",
            "description":"The service profile associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SocialPrivateFlag":{
            "title":"Private Social Post",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the service request was created from a private social post. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "MilestoneLabel":{
            "title":"Milestone Name",
            "maxLength":255,
            "type":"string",
            "description":"The display 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
        },
        "BillToPartySiteFormattedAddress":{
            "title":"Bill-To Party Site Formatted Address",
            "maxLength":5000,
            "type":"string",
            "description":"The formatted address for the customer site to be billed for work performed on the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCdMeaning":{
            "title":"Resolution Value",
            "type":"string",
            "description":"The display value of the resolution lookup code for the service request, such as Satisfied.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ResolutionCd"
                ]
            },
            "x-queryable":true
        },
        "BillToCustomerAccountSiteId":{
            "title":"Bill to Customer Account Site ID",
            "type":"integer",
            "description":"The customer account site to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the service request. For example, New, InProgress, Waiting, Resolved, Closed, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountPartyEmailAddress":{
            "title":"Account Party Email Address",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the account on the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SeverityCdMeaning":{
            "title":"Severity Value",
            "type":"string",
            "description":"The display value of the severity lookup code for the service request, such as High.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SeverityCd"
                ]
            },
            "x-queryable":true
        },
        "PartnerAccountPartyUniqueName":{
            "title":"Partner Account",
            "maxLength":900,
            "type":"string",
            "description":"The unique name to identify the partner account.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "srInteractionReferences":{
            "title":"Interaction References",
            "type":"array",
            "description":"The interaction references resource is used to view the relationship between an interaction and a service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-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 public unique identifier of the person who reported 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":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application stripe of the service request.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusTypeCd":{
            "title":"Status Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status type of the service request. The possible values are, New, In Progress, Waiting, Resolved, and Closed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToPartySiteName":{
            "title":"Bill-To Party Site Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the customer site to be billed for work performed on the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PurchaseOrder":{
            "title":"Purchase Order",
            "maxLength":50,
            "type":"string",
            "description":"The purchase order associated with the service request.",
            "nullable":true,
            "x-queryable":false
        },
        "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 service request in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "contacts":{
            "title":"Contact Members",
            "type":"array",
            "description":"The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-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-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 public unique identifier of the person who last updated the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "addresses":{
            "title":"Service Addresses",
            "type":"array",
            "description":"A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-addresses-item-response"
            }
        },
        "ResolveDescription":{
            "title":"Solution Description",
            "maxLength":1000,
            "type":"string",
            "description":"A brief description of how the problem was resolved.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ServiceRequestEO.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. Typically, the value is the same as Creation Date. However, if the service request was migrated from another system then the Creation Date is the date the SR was created and Date Reported is the date the customer reported the service request.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-Attachment-item-response"
            }
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":100,
            "type":"string",
            "description":"The asset number associated with the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-smartActions-item-response"
            }
        },
        "SrLastUpdatedByPartyName":{
            "title":"Source System SR Last Updated by Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party who last updated the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyMemberId":{
            "title":"Loyalty Member ID",
            "type":"integer",
            "description":"The unique identifier of the loyalty member associated with the customer contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResolveOutcomeCdMeaning":{
            "title":"Outcome Value",
            "type":"string",
            "description":"The display value of the resolution outcome lookup code for the service request, such as Solution Provided.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ResolveOutcomeCd"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactFormattedPhoneNumber":{
            "title":"Primary Contact Phone",
            "type":"string",
            "description":"The phone number of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPrimaryPhoneAreaCode",
                    "PrimaryContactPrimaryPhoneContactPtId",
                    "PrimaryContactPrimaryPhoneCountryCode",
                    "PrimaryContactPrimaryPhoneExtension",
                    "PrimaryContactPrimaryPhoneLineType",
                    "PrimaryContactPrimaryPhoneNumber"
                ]
            }
        },
        "BillToCustomerAccountSiteUsageNumber":{
            "title":"Bill-To Customer Account Site Usage Number",
            "maxLength":255,
            "type":"string",
            "description":"The PUID for the customer account site bill-to usage.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedByDisplayName":{
            "title":"Last Updated By",
            "maxLength":3600,
            "type":"string",
            "description":"The display name of the user who last update the service request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LastUpdatedBy"
                ]
            },
            "x-queryable":true
        },
        "BillToCustomerAccountDescription":{
            "title":"Bill-To Customer Account Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the customer account to be billed for work performed on the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrLastUpdateLogin":{
            "title":"Source System SR Last Updated by User Login ID",
            "maxLength":32,
            "type":"string",
            "description":"The application login id of the user who last updated the service request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LastUpdateLogin"
                ]
            }
        },
        "HandledByAIFlag":{
            "title":"Handled by AI Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether automation agents acted upon the service request at any point in its lifecycle.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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 code indicating the problem with a service request. A list of accepted values is defined in the lookup: ORA_SVC_SR_PROBLEM_TYPE_CD. For example, ORA_SVC_DOCS, ORA_SVC_PRODUCT.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 selected by the user. The selected record set is used to filter the search results.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerAccountPartyName":{
            "title":"Partner Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner account party. Two accounts can have the same party name but not the same unique name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetLocation":{
            "title":"Installed Base Asset Location",
            "maxLength":5000,
            "type":"string",
            "description":"The location address of the installed base asset associated with the service request.",
            "nullable":true,
            "x-queryable":false
        },
        "AffectedPartyPersonId":{
            "title":"Affected Party",
            "type":"string",
            "description":"The unique identifier of the affected person on the service request. This field is only applicable for the human resource help desk application.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AffectedPartyAssignmentNumber"
                ]
            }
        },
        "BillToPartySiteLocationId":{
            "title":"Bill-To Party Site Location ID",
            "type":"integer",
            "description":"The location of the customer site to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "type":"string",
            "description":"The public unique identifier of the product associated with the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "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 person who reported the service request.",
            "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":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AffectedPartyPersonId"
                ]
            },
            "x-queryable":true
        },
        "ServiceProfilePartySiteNumber":{
            "title":"Service Profile Site Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The PUID of the address of the service profile associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeverityCd":{
            "title":"Severity",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the severity of the service request. For example, Sev1, Sev2, Sev3, and Sev4.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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":"Indicates that the primary contact of the service request does not want to be contacted. The default value is false.",
            "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
        },
        "LoyMemberNumber":{
            "title":"Loyalty Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique loyalty member identifier of the service request primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":100,
            "type":"string",
            "description":"The serial number of the asset that is associated with 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 view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srTags-item-response"
            }
        },
        "LanguageCd":{
            "title":"Language Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the customer's preferred language for the service request. For example, en, fr, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 public unique identifier of the assignee of the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerAccountPartyNumber":{
            "title":"Partner Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the partner account associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "srMilestone":{
            "title":"Milestones",
            "type":"array",
            "description":"The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srMilestone-item-response"
            }
        },
        "ChannelTypeCdMeaning":{
            "title":"Channel Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value of the channel type lookup code for the service request, such as Chat, Phone, or Email.",
            "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 code indicating the type of resolution of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ResolveOutcomeCd"
                ]
            },
            "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":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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-hints":{
                "controlType":"check_box"
            },
            "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
        },
        "ResolvedByAIFlag":{
            "title":"Resolved by AI Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request was resolved with the assistance of automation agents.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToCustomerAccountId":{
            "title":"Bill to Customer Account ID",
            "type":"integer",
            "description":"The customer account to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToCustomerName":{
            "title":"Bill-To Customer Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the customer to be billed for work performed on the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Category",
            "type":"integer",
            "description":"The unique identifier of the service request category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18,
                "dependencies":[
                    "BUOrgId",
                    "StripeCd"
                ]
            },
            "x-queryable":true
        },
        "ProductItemOrgId":{
            "title":"Product Organization",
            "type":"integer",
            "description":"The unique identifier of the organization of the product that is associated with the service request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WarnedFlag":{
            "title":"Warned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the milestone passed the warning threshold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeTimezone":{
            "title":"Assignee Time Zone",
            "maxLength":255,
            "type":"string",
            "description":"The time zone of the assignee associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SeverityRank":{
            "title":"Severity Rank",
            "type":"integer",
            "description":"The code indicating the severity of the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastResolvedDate":{
            "title":"Resolution Date",
            "type":"string",
            "description":"The date and time when the service request was last 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,
            "default":0,
            "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,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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 if the service request has been updated.",
            "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":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillToPartySiteNumber":{
            "title":"Bill-To Party Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The PUID for the customer site to be billed for work performed on the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPartyUniqueName":{
            "title":"Primary Contact Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name associated with the primary contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AssigneePartyId":{
            "title":"Assigned to Party ID",
            "type":"integer",
            "description":"The unique identifier of the party object associated with the service request assignee.",
            "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 with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InternalPriorityCd":{
            "title":"Internal Priority Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the internal priority of the service request. For example, High, Normal, Low, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_INT_PRIORITY_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 with the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillToCustomerAccountNumber":{
            "title":"Bill-To Customer Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The PUID for the customer account to be billed for work performed on the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolvedByPartyId":{
            "title":"Resolved by Party ID",
            "type":"integer",
            "description":"The unique identifier of the user who resolved this service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceProfileName":{
            "title":"Service Profile Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the service profile associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneStatusCd":{
            "title":"Milestone Status",
            "maxLength":255,
            "type":"string",
            "description":"The code indicating the status of the milestone. For example, In Progress, Complete. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartySiteId":{
            "title":"Bill-To Party Site ID",
            "type":"integer",
            "description":"The address of the customer site to be billed for work performed on the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountPartyPreferredContactMethod":{
            "title":"Account Party Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method of the account on the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusTypeCdMeaning":{
            "title":"Status Type Value",
            "type":"string",
            "description":"The display value of the status type lookup code for the service request, such as New, or Resolved.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusTypeCd"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedByPartyId":{
            "title":"Last Updated by Party ID",
            "type":"integer",
            "description":"The unique identifier of the party of the user who last updated the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The reference to the service request record in the original system from which service request was imported (if imported).",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SrNumber"
                ]
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":400,
            "type":"string",
            "description":"A brief title of the service request.",
            "nullable":false,
            "x-queryable":true
        },
        "ScheduleId":{
            "title":"Schedule Identifier",
            "type":"integer",
            "description":"The unique identifier of the current schedule associated with the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Reference Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.",
            "nullable":false,
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request queue.",
            "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 name of the person who initiated the resolution process.",
            "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 the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-activities-item-response"
            }
        },
        "LoyMemberName":{
            "title":"Loyalty Member",
            "maxLength":100,
            "type":"string",
            "description":"The name of the loyalty member associated with the customer contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the category associated with 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
        },
        "ServiceProfileNumber":{
            "title":"Service Profile Number",
            "maxLength":30,
            "type":"string",
            "description":"The PUID for the service profile associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductItemNumber":{
            "title":"Product Number",
            "maxLength":255,
            "type":"string",
            "description":"The alternate key identifier 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":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Activities

Type: array

Title: Activities

The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.

Show Source

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

{
    "title":"Activities",
    "type":"array",
    "description":"The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-activities-item-response"
    }
}

Nested Schema : Service Addresses

Type: array

Title: Service Addresses

A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.

Show Source

• Array of: object serviceRequests-addresses-item-response

{
    "title":"Service Addresses",
    "type":"array",
    "description":"A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-addresses-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-Attachment-item-response"
    }
}

Nested Schema : Channel Communications

Type: array

Title: Channel Communications

The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.

Show Source

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

{
    "title":"Channel Communications",
    "type":"array",
    "description":"The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-channelCommunication-item-response"
    }
}

Nested Schema : Contact Members

Type: array

Title: Contact Members

The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.

Show Source

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

{
    "title":"Contact Members",
    "type":"array",
    "description":"The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-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 messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".

Show Source

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

{
    "title":"Messages",
    "type":"array",
    "description":"The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, \"We have credited your account for the value of the call. You should see a credit in your next monthly bill.\" or  \"We have notified the billing department about the issue. This issue should not recur.\".",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-messages-item-response"
    }
}

Nested Schema : Resources

Type: array

Title: Resources

Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.

Show Source

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

{
    "title":"Resources",
    "type":"array",
    "description":"Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-resourceMembers-item-response"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

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

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-smartActions-item-response"
    }
}

Nested Schema : Interaction References

Type: array

Title: Interaction References

The interaction references resource is used to view the relationship between an interaction and a service request.

Show Source

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

{
    "title":"Interaction References",
    "type":"array",
    "description":"The interaction references resource is used to view the relationship between an interaction and a service request.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srInteractionReferences-item-response"
    }
}

Nested Schema : Milestones

Type: array

Title: Milestones

The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.

Show Source

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

{
    "title":"Milestones",
    "type":"array",
    "description":"The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srMilestone-item-response"
    }
}

Nested Schema : Service Request References

Type: array

Title: Service Request References

The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.

Show Source

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

{
    "title":"Service Request References",
    "type":"array",
    "description":"The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srReferences-item-response"
    }
}

Nested Schema : Tags

Type: array

Title: Tags

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

Show Source

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

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

Nested Schema : serviceRequests-activities-item-response

Type: object

Show Source

• AccountAddress: string
  Title: Account Address

  Read Only: true

  The address of the related account.
• AccountId: integer (int64)
  Title: Account ID

  The unique identifier of the activity account, for example customer, organization, person, or partner.
• AccountIdAttr: integer
  The unique identifier of the account. This attribute is for internal use.
• AccountName: string
  Title: Account

  The name of the account associated with the 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 public unique identifier of account associated with the activity.
• AccountPhoneNumber: string
  Title: Account Phone Number

  Read Only: true

  The phone number of the related account.
• AccountStatus: string
  Read Only: true

  Maximum Length: 1

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

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

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

  The date and time of when an appointment ends. The time when a task is completed.
• ActivityFilter: string
  Read Only: true

  The attribute is used to add additional activity filter. This attribute is for internal use.
• ActivityFunctionCode: string
  Title: Activity

  Maximum Length: 30

  The code indicating the function of the activity.
• ActivityFunctionCodeTrans: string
  Title: Activity

  Maximum Length: 255

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

  The unique identifier of the activity.
• ActivityLastUpdateLogin: string
  Title: Activity Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the record.
• ActivityMtgMinutes: string (byte)
  Title: Meeting Minutes

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

  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• 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

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

  The date and time when an appointment or a task begins. The default value for an appointment is null. The default value for a task is the date and time of when a task is created.
• ActivityStatus: string
  Title: Status

  Read Only: true

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

  Maximum Length: 30

  The code indicating the activity subtype that is dependent on the activity type.
• ActivityTimezone: string
  The time zone that the activity needs to be created in, other than the default logged user's time zone preference.
• ActivityType: string
  Title: Activity Type

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

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 1

  Default Value: false

  Indicates whether the appointment is for the entire day. If the value is True, the appointment is for the entire day. The default value is False.
• 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 that is associated to the activity or the activity template.
• AssetId: integer (int64)
  Title: Asset ID

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

  The name of the asset associated with an activity.
• AssetNumber: string
  Title: Asset Number

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

  Read Only: true

  Maximum Length: 100

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

  Default Value: ZMM_ACTY_ACTIVITIES

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

  Maximum Length: 30

  The name of the source for the activity.
• BpId: integer (int64)
  Title: Business Plan ID

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

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

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

  The public unique identifier of business plan associated with the activity.
• CalendarAccess: boolean
  Indicates who has access to the calender.
• CalendarRecurType: string
  The activity recurrence type.
• CalendarSubject: string
  The subject of the activity.
• CalendarSubjectDay: string
  The title of the calender.
• CalendarTimeType: string
  The calender time type of the activity.
• CallReportCount: integer (int32)
  Title: Call Report Count

  Default Value: 0

  A count of the number of call reports.
• CallReportUpcomingYN: string
  Indicates the status of the call report for upcoming appointments.
• CallReportYN: string
  Indicates whether the activity is associated with a call report.
• CampaignId: integer (int64)
  Title: Campaign ID

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

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

  The public unique identifier 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 case number associated with the activity.
• CaseTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 400

  The case title associated with the activity.
• CheckedInBy: string
  Title: Checked-In By

  Maximum Length: 64

  The person who checked into a location.
• CheckedOutBy: string
  Title: Checked-Out By

  Maximum Length: 64

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

  The date and time when a user checks in to a location.
• CheckinLatitude: number
  Title: Check-In Latitude

  The latitude when a user checks in to a location.
• CheckinLongitude: number
  Title: Check-In Longitude

  The longitude when a user checks in to a location.
• CheckoutDate: string (date-time)
  Title: Check-Out Time

  The date and time when a user checks out of a location.
• CheckoutLatitude: number
  Title: Check-Out Latitude

  The latitude when a user checks out of a location.
• CheckoutLongitude: number
  Title: Check-Out Longitude

  The longitude when a user checks out of a location.
• ClaimId: integer (int64)
  Title: Claim ID

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

  The name of the claim associated with the activity.
• ClaimNumber: string
  Title: Claim Number

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

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.
• ContactIDAttr: integer
  The unique identifier of the contact. This attribute is for internal use.
• ContactNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

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

  Maximum Length: 15

  The corporate currency code associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• 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

  The date when the activity was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate

  Maximum Length: 30

  The currency conversion rate type associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrentDateForCallReport: string (date-time)
  The current date for the Call Report.
• CurrentDateForCallReportAttr: string (date-time)
  The current date of the call report. This attribute is for internal use.
• CurrentSystemDtTransient: string (date)
  Read Only: true

  The current system date of the activity.
• CustomerAccountId: integer (int64)
  Title: Customer Account ID

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

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

  The alternate key identifier of the deal associated to the activity. The number can also be generated from an external source.
• DelegatorId: integer (int64)
  Title: Delegator ID

  The unique identifier of the user who delegated the activity to another activity resource.
• DelegatorName: string
  Title: Delegated By

  The name of the user who delegated the activity to another activity resource.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the activity has been deleted.
• DerivedAccountId: integer
  The unique identifier of the account.
• DirectionCode: string
  Title: Direction

  Maximum Length: 30

  The code indicating the direction of an activity. The options are inbound/outbound, optional. The default value is null.
• DismissAssignee: string
  Title: Dismissed

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

  Maximum Length: 1

  Indicates if the calls that were logged for a past appointment are dismissed.
• DoNotCallFlag: boolean
  Read Only: true

  Indicates whether the primary contact can be called. The default value is false.
• DueDate: string (date)
  Title: Due Date

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

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

  The attribute is used to Claim LOV. This attribute is for internal use.
• EmailSentDate: string (date-time)
  The date and time when the activity e-mail notifications are shared through Outlook.
• EndDateForCallReport: string (date-time)
  The date when the call report ends.
• EndDateForCallReportAttr: string (date-time)
  The end date of the call report. This attribute is for internal use.
• EndDtRFAttr: string (date-time)
  The date when the activity ends. This attribute is for internal use.
• ExternalContactEmail: string
  Title: Primary Email

  Maximum Length: 320

  The e-mail 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 whether the activity is created by an external resource.
• FundRequestId: integer (int64)
  Title: Fund Request ID

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

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

  The public unique identifier 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 attribute identifies the recurrence mode. This attribute is for internal use.
• IsClientService: string
  Default Value: Y

  This is obsolete and was for internal usage.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the activity.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The unique identifier of the user who last logged in to the application.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier of the related lead.
• LeadIdAttr: integer
  The unique identifier of the lead. This attribute is for internal use.
• LeadName: string
  Title: Lead

  The name of the activity lead.
• LeadNameOsn: string
  Title: Social Lead Name

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

  The public unique identifier of the 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

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

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

  Maximum Length: 50

  The code indicating whether an external mobile was used for an activity.
• 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 unique identifier of the opportunity. This attribute is for internal use.
• OpportunityName: string
  Title: Opportunity

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

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

  The public unique identifier 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 identifier of the activity.
• OtherPartyPhoneNumber: string
  Title: Other Party Phone Number

  Maximum Length: 40

  The inbound phone number that is used to make a call. Identifies the phone number dialed for outbound calls.
• OutcomeCode: string
  Title: Outcome

  Maximum Length: 30

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

  Maximum Length: 1

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

  Maximum Length: 1

  Default Value: false

  Indicates whether the activity is created in Outlook. If the value is Y, then the activity is created in Outlook and synchronized.
• 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 for the activity in Outlook.
• OwnerAddress: string
  Title: Activity Owner Address

  Read Only: true

  The address of the activity owner.
• OwnerEmailAddress: string
  Title: Activity Owner Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the activity owner.
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier of the activity owner.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The name of the owner of the 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 phone number of the activity owner.
• ParentActivityId: integer (int64)
  Title: Parent ID

  The unique identifier of the related activity ID, only applicable if the record is a follow up activity.
• ParentActivityIdAttr: string
  The unique identifier of the parent activity. This attribute is for internal use.
• 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 related program enrollment.
• PartnerEnrollmentNumber: string
  Title: Enrollment Number

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

  The unique identifier of the party associated with the partner account.
• PartnerPartyName: string
  Title: Partner

  Maximum Length: 80

  The name of the party associated with the partner account.
• PartnerPartyNumber: string
  Title: Partner Number

  The public unique identifier of partner associated with the activity.
• PartnerProgramId: integer (int64)
  Title: Partner Program ID

  The unique identifier of the related partner program.
• PartnerProgramName: string
  Title: Program

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

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

  Maximum Length: 1

  Default Value: false

  Indicates whether the activity is created for an organization account with usage as Partner.
• PercentageComplete: number
  Title: Percentage Complete

  Default Value: 0

  The amount of activity completed in percentage. This is a free form numeric value ranging from 0 to 100.
• PrimaryContactEmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the primary contact for the activity.
• PrimaryContactId: integer (int64)
  Title: Primary Contact ID

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

  The name of the primary contact of the activity.
• 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 formatted address information of the activity primary contact.
• PrimaryFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

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

  Maximum Length: 30

  The code indicating the priority of the activity. The default value is 2. The possible values are, 1, 2, or 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

  The recurrence of an appointment on a specific day of the month.
• RecurEndDate: string (date-time)
  Title: Ends

  The date when a recurring activity ends.
• RecurEveryOptionFlag: boolean
  Title: Recurrence Option

  Maximum Length: 1

  Indicates the frequency of recurrence of an activity. If the recurrence is everyday of the week, it is set to Y if it is weekdays only, it is set to N. The recurring options are every day, week, month, year, and so on.
• RecurExceptionFlag: boolean
  Title: Recurrence Exception

  Maximum Length: 1

  Indicates if the appointment instance is updated outside the recurring appointment series.
• RecurFrequency: number
  Title: Repeat

  The frequency with which the recurring appointment series repeats.
• RecurFriFlag: boolean
  Title: Friday

  Maximum Length: 1

  Indicates if an appointment recurs every Friday.
• RecurMonFlag: boolean
  Title: Monday

  Maximum Length: 1

  Indicates if an appointment recurs every Monday.
• RecurMonth: string
  Title: Month

  Maximum Length: 30

  The recurrence of an appointment in a specified month.
• RecurNumberOfInstances: number
  Title: Number of Instances

  The specific number of occurrences for the series, after which the recurring series ends.
• RecurOrigInstDate: string (date-time)
  Title: Original Instance Date

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

  Maximum Length: 30

  The recurring appointment for a specific week, for example, First, Second, Third, Fourth, Last. The recurrence can be monthly or yearly.
• RecurRecType: string
  Title: Recurrence Record Type

  Maximum Length: 1

  Default Value: N

  The type of recurrence of an Activity, for example "I" for instance, "S" for series, or "N" for non-recurring. For Internal Use Only. Do not populate it if Activity is of type Task.
• RecurSatFlag: boolean
  Title: Saturday

  Maximum Length: 1

  Indicates if the activity recurs on Saturday.
• RecurSeriesId: integer (int64)
  Title: Recurrence Series ID

  The unique identifier for the series that links instances of a series together.
• RecurSunFlag: boolean
  Title: Sunday

  Maximum Length: 1

  Indicates if the activity recurs on Sunday.
• RecurThuFlag: boolean
  Title: Thursday

  Maximum Length: 1

  Indicates if the activity recurs on Thursday.
• RecurTueFlag: boolean
  Title: Tuesday

  Maximum Length: 1

  Indicates if the activity recurs on Tuesday.
• RecurTypeCode: string
  Title: Recurrence Type

  Maximum Length: 30

  The code indicating how often an appointment recurs, for example Daily, Weekly, Monthly, or 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

  Indicates if the activity recurs on Wednesday.
• RecurWeekday: string
  Title: Pattern Type

  Maximum Length: 30

  The type of recurrence of an activity, for example Monday to Sunday, Weekday, Weekend, or a specific Day.
• ReferenceCustomerActTypeCode: string
  Title: Reference Customer Activity Type

  Maximum Length: 30

  The activity that refers to the activity of a customer. To be used for adjustment only.
• ReferenceCustomerId: integer (int64)
  Title: Reference Customer

  The unique identifier of the referenced customer who is associated with the activity.
• ReminderPeriod: string
  Title: Set Reminder

  Indicates when the reminder should be sent.
• ResourceNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the activity owner.
• ResponseCode: string
  Title: Response

  Indicates whether a reminder is required.
• SalesObjectiveName: string
  Title: Sales Objective

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

  The public unique identifier of 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

  The show status of the the activity such as open, complete, or all activities.
• ShowTimeAs: string
  Title: Show Time As

  The choice of display of time on your calendar for an 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

  The date used to sort the activities. The sort date can be the appointment start date, the task due date, or the task complete date.
• SourceObjectCode: string
  The code indicating the source object associated with the activity.
• SourceObjectId: integer
  The unique identifier of the object associated with the activity.
• SrId: integer (int64)
  Title: Service Request ID

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

  The alternate key identifier of the service request.
• StartDateForCallReport: string (date-time)
  The date when the call report starts.
• StartDateForCallReportAttr: string (date-time)
  The start date of the call report. This attribute is for internal use.
• StartDtRFAttr: string (date-time)
  The date when the activity starts. This attribute is for internal use.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The status of the activity. The default value is Not Started.
• Subject: string
  Title: Subject

  Maximum Length: 500

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

  The user who submitted the Call Report.
• SubmittedByName: string
  Title: Submitted By

  Maximum Length: 255

  The name of the user who submitted the Call Report.
• SubmittedDate: string (date-time)
  Title: Submitted Date

  The date and time when the Call Report was submitted.
• 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 reminder period for a task due date, such as one day before the task due date.
• TemplateDuration: number
  Title: Template Duration

  The duration in number of days, for the template activity. This attribute is used with the start date when generating an activity from a template in order 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

  Ithe identifier of the template associated with the activity.
• TemplateLeadTime: number
  Title: Lead Time

  The lead time that is calculated from the activity start date, for the template activity.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the activity has been updated.
• UpgSourceObjectId: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 30

  The source object type of the activity such as Appointment, Task, or Interaction. It indicates 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 person who checks out of a location.",
            "nullable":true,
            "x-queryable":true
        },
        "FundRequestNumber":{
            "title":"Fund Request Number",
            "type":"string",
            "description":"The public unique identifier 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":"The currency conversion rate type associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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":"The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactEmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the primary contact for the activity.",
            "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":"The show status of the the activity such as open, complete, or all activities.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PercentageComplete":{
            "title":"Percentage Complete",
            "type":"number",
            "description":"The amount of activity completed in percentage. This is a free form numeric value ranging from 0 to 100.",
            "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 user who last updated the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurFrequency":{
            "title":"Repeat",
            "type":"number",
            "description":"The frequency with which the recurring appointment series repeats.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityPriority":{
            "title":"Priority",
            "type":"string",
            "description":"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 code indicating the function of the activity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerAddress":{
            "title":"Activity Owner Address",
            "type":"string",
            "description":"The address of the activity owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The unique identifier of 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":"Indicates if an appointment recurs every 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 calender.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the activity has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentDateForCallReportAttr":{
            "type":"string",
            "description":"The current date of the call report. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DelegatorId":{
            "title":"Delegator ID",
            "type":"integer",
            "description":"The unique identifier of the user who delegated the activity to another activity resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecurWeekday":{
            "title":"Pattern Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of recurrence of an activity, for example Monday to Sunday, Weekday, Weekend, or a specific 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 case title associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurTueFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs on Tuesday.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the user who last logged in to the application.",
            "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 that refers to the activity of a customer. To be used for adjustment only.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityCreationDate":{
            "title":"Activity Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerUsageFlag":{
            "title":"Partner Usage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity is 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 reminder period for a task due date, such as one day before the task due date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstNumDerivedFrom":{
            "type":"string",
            "description":"The attribute identifies the recurrence mode. This attribute is for internal use.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the related 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 date when the activity starts. This attribute is for internal use.",
            "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":"Indicates whether a reminder is required.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IsClientService":{
            "type":"string",
            "description":"This is obsolete and was for internal usage.",
            "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 code indicating 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 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 minutes of an activity meeting.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "SortDate":{
            "title":"Date",
            "type":"string",
            "description":"The date used to sort the activities. The sort date can be the appointment start date, the task due date, or the task complete date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SalesObjectiveNumber":{
            "title":"Sales Objective Number",
            "type":"string",
            "description":"The public unique identifier of sales objective associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentActivityIdAttr":{
            "type":"string",
            "description":"The unique identifier of the parent activity. This attribute is for internal use.",
            "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 public unique identifier of the activity owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object associated with the activity.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceCustomerId":{
            "title":"Reference Customer",
            "type":"integer",
            "description":"The unique identifier of the referenced customer who is 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 person who checked into a location.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the activity was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivedAccountId":{
            "type":"integer",
            "description":"The unique identifier of the account.",
            "nullable":true,
            "x-queryable":false
        },
        "OutcomeCode":{
            "title":"Outcome",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating 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 activity account, for example customer, organization, person, or partner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternallyOwnedFlag":{
            "title":"Externally Owned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity is created by an external 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 for the activity in Outlook.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the activity. The default value is Not Started.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DelegatorName":{
            "title":"Delegated By",
            "type":"string",
            "description":"The name of the user who delegated the activity to another activity resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CheckinLatitude":{
            "title":"Check-In Latitude",
            "type":"number",
            "description":"The latitude when a user checks in to a location.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of primary contact associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateForCallReport":{
            "type":"string",
            "description":"The date when the call report ends.",
            "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 unique identifier of the party associated with the partner account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivitySubtypeCode":{
            "title":"Subtype",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the activity subtype that is dependent on the activity type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ActivityTypeCode",
                    "ActivityFunctionCode"
                ]
            },
            "x-queryable":true
        },
        "SalesObjectiveName":{
            "title":"Sales Objective",
            "type":"string",
            "description":"The name of the sales objective associated with 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 user who submitted the Call Report.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerPhoneNumber":{
            "title":"Activity Owner Phone Number",
            "type":"string",
            "description":"The phone number of the activity owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssetName":{
            "title":"Asset",
            "type":"string",
            "description":"The name of the asset associated with an activity.",
            "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 associated asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckoutLongitude":{
            "title":"Check-Out Longitude",
            "type":"number",
            "description":"The longitude when a user checks out of a location.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityName":{
            "title":"Opportunity",
            "type":"string",
            "description":"The name of the opportunity associated with 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":"The inbound phone number that is used to make a call. Identifies the phone number dialed for outbound calls.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerEmailAddress":{
            "title":"Activity Owner Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the activity owner.",
            "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 record was last updated by the activity user.",
            "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 is created in Outlook. If the value is Y, then the activity is created in Outlook and synchronized.",
            "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":"The date and time when a user checks out of a location.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerEnrollmentId":{
            "title":"Enrollment ID",
            "type":"integer",
            "description":"The unique identifier of the related program enrollment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date and time when the Call Report was submitted.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerPartyNumber":{
            "title":"Partner Number",
            "type":"string",
            "description":"The public unique identifier of partner associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurEveryOptionFlag":{
            "title":"Recurrence Option",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the frequency of recurrence of an activity. If the recurrence is everyday of the week, it is set to Y if it is weekdays only, it is set to N. The recurring options are every day, week, month, year, and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the activity has been updated.",
            "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 name of the party associated with the partner account.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RecurRecType":{
            "title":"Recurrence Record Type",
            "maxLength":1,
            "type":"string",
            "description":"The type of recurrence of an Activity, for example \"I\" for instance, \"S\" for series, or \"N\" for non-recurring. For Internal Use Only. Do not 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 related to the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the related lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecurPattern":{
            "title":"Pattern",
            "maxLength":30,
            "type":"string",
            "description":"The recurring appointment for a specific week, for example, First, Second, Third, Fourth, Last. The recurrence can be monthly or yearly.",
            "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 alternate key identifier of the service request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SrId"
                ]
            },
            "x-queryable":true
        },
        "MdfRequestId":{
            "type":"integer",
            "description":"The unique identifier of the fund request.",
            "nullable":true,
            "x-queryable":false
        },
        "Subject":{
            "title":"Subject",
            "maxLength":500,
            "type":"string",
            "description":"The title 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 public unique identifier of account associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time of when an appointment ends. The time when a task is completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReminderPeriod":{
            "title":"Set Reminder",
            "type":"string",
            "description":"Indicates when the reminder should be sent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurNumberOfInstances":{
            "title":"Number of Instances",
            "type":"number",
            "description":"The specific number of occurrences for the series, after which the recurring series ends.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadName":{
            "title":"Lead",
            "type":"string",
            "description":"The name of the activity lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "LeadId"
                ]
            },
            "x-queryable":true
        },
        "StartDateForCallReportAttr":{
            "type":"string",
            "description":"The start date of the call report. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecurSeriesId":{
            "title":"Recurrence Series ID",
            "type":"integer",
            "description":"The unique identifier for the series 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":"The location of the appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the activity was created.",
            "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":"The date and time when a user checks in to a location.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MobileActivityCode":{
            "title":"Mobile Activity Code",
            "maxLength":50,
            "type":"string",
            "description":"The code indicating whether an external mobile was used for an activity.",
            "nullable":true,
            "x-queryable":false
        },
        "AutoLogSource":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The name of the source for the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadIdAttr":{
            "type":"integer",
            "description":"The unique identifier of the lead. This attribute is for internal use.",
            "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 value used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).  This attribute is obsolete.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactIDAttr":{
            "type":"integer",
            "description":"The unique identifier of the contact. This attribute is for internal use.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "type":"string",
            "description":"The code indicating the source object associated with the activity.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "type":"string",
            "description":"The public unique identifier of the campaign associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "CallReportUpcomingYN":{
            "type":"string",
            "description":"Indicates the status of the call report for upcoming appointments.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactName":{
            "title":"Primary Contact",
            "type":"string",
            "description":"The name of the primary contact of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RecurEndDate":{
            "title":"Ends",
            "type":"string",
            "description":"The date when a recurring activity ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecurMonFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if an appointment recurs every Monday.",
            "nullable":true,
            "x-queryable":false
        },
        "OpportunityNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"The public unique identifier of the opportunity associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "type":"integer",
            "description":"The user who submitted the Call Report.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"The public unique identifier of the lead associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityUpdateDate":{
            "title":"Activity Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarSubject":{
            "type":"string",
            "description":"The subject of the activity.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of an asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The name of the account associated with the 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 public unique identifier of partner program associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the activity contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the priority of the activity. The default value is 2. The possible values are, 1, 2, or 3.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Deal Registration",
            "type":"string",
            "description":"The alternate key identifier of the deal associated to the activity. The number can also be generated from an external source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EndDtRFAttr":{
            "type":"string",
            "description":"The date when the activity ends. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalContactEmail":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of an external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicClaimLOVSwitcher":{
            "type":"string",
            "description":"The attribute is used to Claim LOV. This attribute is for internal use.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DismissAssignee":{
            "title":"Dismissed",
            "type":"string",
            "description":"Indicates whether the assignee is dismissed. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityIdAttr":{
            "type":"integer",
            "description":"The unique identifier of the opportunity. This attribute is for internal use.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityCreatedBy":{
            "title":"Activity Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the activity owner.",
            "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 of the activity.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "type":"string",
            "description":"The case number associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CaseId"
                ]
            },
            "x-queryable":true
        },
        "RecurWedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs on Wednesday.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDateForCallReport":{
            "type":"string",
            "description":"The date when the call report starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateDuration":{
            "title":"Template Duration",
            "type":"number",
            "description":"The duration in number of days, for the template activity. This attribute is used with the start date when generating an activity from a template in order to calculate the due date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":3
            }
        },
        "RecurSatFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs on Saturday.",
            "nullable":true,
            "x-queryable":false
        },
        "ClaimNumber":{
            "title":"Claim Number",
            "type":"string",
            "description":"The public unique identifier 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 if the calls that were logged for a past appointment are dismissed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the account or contact location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecurThuFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity recurs 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 login of the user of the activity. This attribute is for internal use.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerProgramName":{
            "title":"Program",
            "type":"string",
            "description":"The name of the partner program associated with the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerProgramId"
                ]
            }
        },
        "RecurTypeCode":{
            "title":"Recurrence Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how often an appointment recurs, for example Daily, Weekly, Monthly, or Yearly.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDateForCallReportAttr":{
            "type":"string",
            "description":"The end date of the call report. This attribute is for internal use.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OsnActivityId":{
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecurExceptionFlag":{
            "title":"Recurrence Exception",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the appointment instance is updated outside the recurring appointment series.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The attachment of the entity name.",
            "nullable":true,
            "default":"ZMM_ACTY_ACTIVITIES",
            "x-queryable":false
        },
        "CallReportYN":{
            "type":"string",
            "description":"Indicates whether the activity is associated with a call report.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityLastUpdateLogin":{
            "title":"Activity Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFormattedAddress":{
            "title":"Primary Contact Address",
            "type":"string",
            "description":"The formatted address information of the activity 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":"The latitude when a user checks out of a location.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "type":"string",
            "description":"The alternate key identifier of the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountAddress":{
            "title":"Account Address",
            "type":"string",
            "description":"The address of the related account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the associated account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessPlanName":{
            "title":"Business Plan",
            "type":"string",
            "description":"The name of the business plan associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":64,
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":false,
            "x-queryable":true
        },
        "FundRequestName":{
            "title":"MDF Request",
            "type":"string",
            "description":"The name of the fund request associated with 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":"The longitude when a user checks in to a location.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurOrigInstDate":{
            "title":"Original Instance Date",
            "type":"string",
            "description":"The 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":"Indicates if the activity recurs on Sunday.",
            "nullable":true,
            "x-queryable":false
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the appointment is for the entire day. If the value is True, the appointment is for the entire day. The default value is False.",
            "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 associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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":"The date and time when the activity e-mail notifications are shared through Outlook.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimName":{
            "title":"MDF Claim",
            "type":"string",
            "description":"The name of the claim associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AccountPhoneNumber":{
            "title":"Account Phone Number",
            "type":"string",
            "description":"The phone number of the related account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of the assessment that is associated to the activity or the activity template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalendarTimeType":{
            "type":"string",
            "description":"The calender time type of the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurMonth":{
            "title":"Month",
            "maxLength":30,
            "type":"string",
            "description":"The recurrence of an appointment in a specified month.",
            "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":"The time zone that the activity needs to be created in, other than the default logged user's time zone preference.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the owner of the 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Description",
            "type":"string",
            "description":"A text area for capturing information about the activity.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ActivityEO.ActivityDesc",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "RecurDay":{
            "title":"Day",
            "type":"integer",
            "description":"The recurrence of an appointment on a specific day of the month.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ActivityStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when an appointment or a task begins. The default value for an appointment is null. The default value for a task is the date and time of when a task is created.",
            "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 last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignName":{
            "title":"Campaign",
            "type":"string",
            "description":"The name of the campaign associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CampaignId"
                ]
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "type":"string",
            "description":"The public unique identifier of business plan associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowTimeAs":{
            "title":"Show Time As",
            "type":"string",
            "description":"The choice of display of time on your calendar for an activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccountIdAttr":{
            "type":"integer",
            "description":"The unique identifier of the account. This attribute is for internal use.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "type":"boolean",
            "description":"Indicates whether the primary contact can be called. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when 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":"Ithe identifier of the template associated with the activity.",
            "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 unique identifier of the related activity ID, 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 activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ActivityTypeCode"
                ]
            }
        },
        "AccountType":{
            "maxLength":30,
            "type":"string",
            "description":"The party type of the associated account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DirectionCode":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the direction of an activity. The options are inbound/outbound, optional. The default value is null.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TemplateLeadTime":{
            "title":"Lead Time",
            "type":"number",
            "description":"The lead time that is calculated from the activity start date, for the template activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":3
            }
        },
        "CalendarAccess":{
            "type":"boolean",
            "description":"Indicates who has access to the calender.",
            "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 of the activity such as Appointment, Task, or Interaction. It indicates the source of the upgraded record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityFilter":{
            "type":"string",
            "description":"The attribute is used to add additional activity filter. This attribute is for internal use.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The 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 : serviceRequests-addresses-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first address line of the service address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address line of the service address.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address line of the service address.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line of the service address.
• AddressSourceCd: string
  Title: Address Source Code

  Maximum Length: 30

  Indicates the source of the service address of the service request. For example, the address source can be account or contact.
• City: string
  Title: City

  Maximum Length: 60

  The city of the service address.
• Country: string
  Title: Country

  Maximum Length: 2

  The country of the service address.
• County: string
  Title: County

  Maximum Length: 60

  The county of the service address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the service address was created.
• FormattedAddress: string
  Title: Formatted Address

  Read Only: true

  Maximum Length: 1000

  The formatted address value of the service address.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

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

  The location that was the source of the service address.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The customer address that was the source of the service address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the service address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the service address.
• ServiceAddressId: integer (int64)
  Title: Service Address ID

  The unique identifier of the service address record.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request associated to the service address.
• State: string
  Title: State

  Maximum Length: 60

  The state of the service address.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 50

  The time zone of the service address.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":50,
            "type":"string",
            "description":"The time zone of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the service address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceAddressId":{
            "title":"Service Address ID",
            "type":"integer",
            "description":"The unique identifier of the service address record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "maxLength":1000,
            "type":"string",
            "description":"The formatted address value of the service address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The location that was the source of the service address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address line of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The customer address that was the source of the service address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressSourceCd":{
            "title":"Address Source Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the source of the service address of the service request. For example, the address source can be account or contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request associated to the service address.",
            "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 address 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 address.",
            "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 : serviceRequests-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded 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 name of the attachment category.
• 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 attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name of the person who uploaded the image.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  The code indicating the type of the data.
• Description: string
  Title: Description

  Maximum Length: 255

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

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• 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 code indicating the type of error, 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 date when the contents in the attachment expire.
• 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 URL of the attachment.
• 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 attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name of the person who last updated the image.
• 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 length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AttachmentsDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-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 the 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/serviceRequests-Attachment-AttachmentsPreview-item-response"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "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 of the person who uploaded the image.",
            "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 length 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 current version number of the attachment.",
            "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 attachment.",
            "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 associated with 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 attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the data.",
            "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 of the person who last updated the image.",
            "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 of the 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 URL of the attachment.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of the attachment category.",
            "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":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : AttachmentsDFFVL

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-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 serviceRequests-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/serviceRequests-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 : serviceRequests-Attachment-AttachmentsDFFVL-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  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",
            "description":"Context Segment",
            "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",
            "description":"Context Segment",
            "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 : serviceRequests-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 : serviceRequests-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, an account name would be the inbound mailbox for support like [e-mail].
• 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 is 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 and 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.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

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

  The unique identifier of the inbound object that resulted in the creation of the service request message.
• 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 is being communicated with.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The party name of the person who is being communicated with. The user can be an internal resource or a customer contact.
• 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 Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.
• PersonId: integer (int64)
  Title: Person ID

  The unique identifier of the person who is a contact on the service request.
• 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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

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

  Read Only: true

  The unique identifier of the channel communication.

{
    "type":"object",
    "properties":{
        "ChannelAccountName":{
            "title":"Account Name",
            "maxLength":400,
            "type":"string",
            "description":"The account name associated with the channel. For example, for email, an account name would be the inbound mailbox for support like [e-mail].",
            "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 channel communication.",
            "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 is being communicated with. The user can be an internal resource or a customer contact.",
            "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 if the channel communication has been deleted.",
            "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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.",
            "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 is 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 and 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_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 if the channel communication has been updated.",
            "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 Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc 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 message.",
            "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 is being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the person who is a contact on the service request.",
            "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 : serviceRequests-contacts-item-response

Type: object

Show Source

• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

  The service request access level granted to the 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 party associated with the contact.
• ContactFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the party associated with 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 public unique identifier of the contact associated with the service request.
• ContactPreferredContactMethod: string
  Title: Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred contact method of the party associated with 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 associated with the contact.
• 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.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates if the contact has been deleted.
• DoNotContactFlag: boolean
  Title: Do Not Contact

  Read Only: true

  Maximum Length: 1

  Indicates whether the contact of the service request does not want to be contacted. The default value is false.
• FormattedAddress: string
  Title: Formatted Address

  Read Only: true

  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 record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The application login id of the user who last updated the contacts 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 identification of a person that is a contact on a service request.This is only used for human resource help desk service request.
• PrimaryContactFlag: boolean
  Title: Primary

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

  Maximum Length: 30

  The code indicating the type of 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 public unique number of the a service request.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the contact has been updated.

{
    "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 if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of 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 associated with the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The service request access level granted to the 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 if the contact has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method of the party associated with 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 record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the party associated with 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 created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "type":"string",
            "description":"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 public unique number of the a service request.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the contact has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the party associated with 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 does not want to be contacted. The default value is false.",
            "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 identification of a person that is a contact on a service request.This is only used for human resource help desk service request.",
            "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 application login id of the user who last updated the contacts 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 : serviceRequests-messages-item-response

Type: object

Show Source

• AILogLevelCd: string
  Title: AI Log Level Code

  Maximum Length: 30

  Default Value: ORA_SVC_NONE

  Indicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.
• channelCommunication: array Channel Communications
  Title: Channel Communications

  The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes 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 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.
• CollabResource: string
  Title: Collaboration Resource

  This field is reserved for internal use only.
• 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 e-mail address of the person who created the service request message.
• CreatedByPartyId: string
  Title: Created by Party ID

  Read Only: true

  Maximum Length: 80

  The unique identifier of the party of the user 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 if the message has been deleted.
• FeedFlag: boolean
  Title: Feed Flag

  Maximum Length: 1

  Default Value: true

  Indicates whether the SR Message should be pushed to the SR Feed. Values are Y and N.
• 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 session login associated with 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 message encoded in base 64 format. Any attachment associated with the message is not the content of the 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

  Indicates 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 last updated date of the message 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 update 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 update 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 code indicating the message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_TYPE_CD.
• 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.
• NotificationProcessingStatusCd: string
  Title: Notification Processing Status Code

  Maximum Length: 30

  The code indicating the status of the response notification. For example, Error, Success. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD.
• NotificationRetryCount: integer (int32)
  Title: Notification Retry Count

  The number of times the system tried to send the SR message notification.
• 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 Code

  Maximum Length: 30

  Default Value: SVC_SR_MESSAGES

  This field is reserved for internal use only.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The 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 service request message.
• PartyName: string
  Title: Posted By

  Read Only: true

  Maximum Length: 360

  The Party name of the user who the 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 public unique identifier of the person posting the message on the service request.
• 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 code indicating the processing status of the message. The accepted values are Ready, Processing, Error, and Success.A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD .
• ReplyToMessageId: integer (int64)
  Title: Reply to Message ID

  Read Only: true

  The unique identifier of the message that is being replied to by the agent.
• 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 latest 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 message was created from a private social post.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  The code indicating the source of the message. For example, Agent UI, Customer UI, and API. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD.
• 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 public unique number of the a service request.
• 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 code indicating 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 used to send an email response to a customer.
• 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 level of the thread in the message hierarchy.
• ThreadId: integer
  Title: Thread Identifier

  Read Only: true

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

  Read Only: true

  The date when the message 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 if the message has been updated.
• VisibilityCd: string
  Title: Visibility Code

  Maximum Length: 30

  The code indicating the privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_VISIBILITY_CD.

{
    "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 message encoded in base 64 format. Any attachment associated with the message is not the content of the 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 code indicating the status of the response notification. For example, Error, Success. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD.",
            "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 the 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 last updated date of the message 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, update, and delete attachments associated with a message. An attachment includes additional information about a message.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-messages-Attachment-item-response"
            }
        },
        "MessageExpandingState":{
            "title":"Message Expand State",
            "type":"integer",
            "description":"Indicates the message expanding state.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplyToMessageId":{
            "title":"Reply to Message ID",
            "type":"integer",
            "description":"The unique identifier of the message that is being replied to by the agent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the source of the message. For example, Agent UI, Customer UI, and API. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CollabResource":{
            "title":"Collaboration Resource",
            "type":"string",
            "description":"This field is reserved for internal use only.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ThreadHierarchyLevel":{
            "title":"Thread Hierarchy Level",
            "type":"integer",
            "description":"The level of the thread in the message hierarchy.",
            "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 code indicating the processing status of the message. The accepted values are Ready, Processing, Error, and Success.A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD .",
            "nullable":true,
            "default":"ORA_SVC_READY",
            "x-queryable":true
        },
        "MessageLastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last update 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 identifier of the party of the user who created the service request message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"This field is reserved for internal use only.",
            "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
        },
        "FeedFlag":{
            "title":"Feed Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the SR Message should be pushed to the SR Feed. Values are Y and N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 if the message has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NotificationRetryCount":{
            "title":"Notification Retry Count",
            "type":"integer",
            "description":"The number of times the system tried to send the SR message notification.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "AILogLevelCd":{
            "title":"AI Log Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE.",
            "nullable":false,
            "default":"ORA_SVC_NONE",
            "x-hints":{
                "controlType":"choice"
            },
            "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 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":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with 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 latest 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 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":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 code indicating the privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.  A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_VISIBILITY_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageTypeCd":{
            "title":"Message Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. A list of accepted values is defined in the lookup  \nORA_SVC_MESSAGE_TYPE_CD.",
            "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 message was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the message has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ThreadId":{
            "title":"Thread Identifier",
            "type":"integer",
            "description":"The unique ID 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 used to send an email response to a customer.",
            "nullable":true,
            "x-queryable":true
        },
        "channelCommunication":{
            "title":"Channel Communications",
            "type":"array",
            "description":"The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-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 message 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. 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
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating 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 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 service request message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique number of the a service request.",
            "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 public unique identifier of the person posting the message on the service request.",
            "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 e-mail address 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 update 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, update, and delete attachments associated with a message. An attachment includes additional information about a message.

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-messages-Attachment-item-response"
    }
}

Nested Schema : Channel Communications

Type: array

Title: Channel Communications

The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.

Show Source

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

{
    "title":"Channel Communications",
    "type":"array",
    "description":"The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-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 : serviceRequests-messages-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded 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 name of the attachment category.
• 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 attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name of the person who uploaded the image.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  The code indicating the type of the data.
• Description: string
  Title: Description

  Maximum Length: 255

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

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• 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 code indicating the type of error, 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 date when the contents in the attachment expire.
• 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 URL of the attachment.
• 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 attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name of the person who last updated the image.
• 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 length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AttachmentsDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-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 the 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/serviceRequests-messages-Attachment-AttachmentsPreview-item-response"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "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 of the person who uploaded the image.",
            "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 length 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 current version number of the attachment.",
            "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 attachment.",
            "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 associated with 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 attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the data.",
            "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 of the person who last updated the image.",
            "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 of the 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 URL of the attachment.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of the attachment category.",
            "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":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : AttachmentsDFFVL

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-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 serviceRequests-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/serviceRequests-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 : serviceRequests-messages-Attachment-AttachmentsDFFVL-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  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",
            "description":"Context Segment",
            "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",
            "description":"Context Segment",
            "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 : serviceRequests-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 : serviceRequests-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, an account name would be the inbound mailbox for support like [e-mail].
• 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 is 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 and 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 message.
• 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 is being communicated with.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The party name of the person who is being communicated with. The user can be an internal resource or a customer contact.
• 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 Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.
• PersonId: integer (int64)
  Title: Person ID

  The unique identifier of the person who is a contact on the service request.
• 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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.
• ViaId: integer (int64)
  Title: ID

  Read Only: true

  The unique identifier of the channel communication.

{
    "type":"object",
    "properties":{
        "ChannelAccountName":{
            "title":"Account Name",
            "maxLength":400,
            "type":"string",
            "description":"The account name associated with the channel. For example, for email, an account name would be the inbound mailbox for support like [e-mail].",
            "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 channel communication.",
            "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 is being communicated with. The user can be an internal resource or a customer contact.",
            "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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.",
            "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 is 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 and 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 Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc 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 message.",
            "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 is being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the person who is a contact on the service request.",
            "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 : serviceRequests-resourceMembers-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the resource as a member of the service request.
• 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 if the resource member has been deleted.
• 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 application login associated with 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 service request resource member record.
• ObjectId: integer (int64)
  Title: Service Request Team Member Resource ID

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

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_RESOURCE

  The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD .
• OwnerFlag: boolean
  Title: Assigned To

  Indicates if 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 individual resource added as 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

  Indicates the formatted address of the service request 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 individual resource added as service request resource member.
• ResourcePartyNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the service request team member.
• SrId: integer (int64)
  Title: Service Request ID

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

  Maximum Length: 30

  The public unique identifier of the service request number.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the resource member has been updated.
• UserGUID: string
  Title: User GUID

  Read Only: true

  Maximum Length: 64

  A globally unique identifier of the resource added as the service request resource member.
• UserId: integer (int64)
  Title: User ID

  Read Only: true

  The user identifier of the resource added as 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 resource as a member of the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Service Request Team Member Resource ID",
            "type":"integer",
            "description":"The unique identifier of the individual resource added as service request resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserGUID":{
            "title":"User GUID",
            "maxLength":64,
            "type":"string",
            "description":"A globally unique identifier of the resource added as the service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the individual resource added as service request resource member.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Assigned To",
            "type":"boolean",
            "description":"Indicates if 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 individual resource added as service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceFormattedAddress":{
            "title":"Resource Formatted Address",
            "type":"string",
            "description":"Indicates the formatted address of the service request 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 public unique identifier of the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the resource member has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"A unique identifier service request resource member record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the resource member has been updated.",
            "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 user identifier of the resource added as 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":"The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD .",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_RESOURCE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request team member.",
            "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 that the resource is associated with.",
            "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 application login associated with 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 : serviceRequests-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

  The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The media type of the smart action REST operation.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display name of the smart action.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The relative path of the smart action REST resource. The path can include path parameters.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The client applications that the smart action is associated with.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Indicates whether an action is designed to operate on multiple object instances selected by an end user.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function for 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 whether the action is smart suggest enabled.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the smart action definition.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The unique identifier of the smart action name.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionRank: integer (int64)
  Title: Priority

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionURLBinding: array Smart Action REST Path Parameter Definitions
  Title: Smart Action REST Path Parameter Definitions

  The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action is smart suggest enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an action is designed to operate on multiple object instances selected by an end user.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The unique identifier of the smart action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "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 for 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

The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

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

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

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

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action REST Path Parameter Definitions

Type: array

Title: Smart Action REST Path Parameter Definitions

The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

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

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : serviceRequests-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

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "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":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "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 : serviceRequests-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• 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

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "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":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "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 : serviceRequests-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Default Value: false

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique identifier of a smart action REST path parameter name-value pair definition.",
            "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":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-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 : serviceRequests-srInteractionReferences-item-response

Type: object

Show Source

• AccountPartyId: integer (int64)
  Title: Account ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 900

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

  Read Only: true

  Maximum Length: 400

  The name of the display channel.
• 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 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.
• ContactPartyId: integer (int64)
  Title: Contact ID

  Read Only: true

  The unique identifier of the interaction contact.
• ContactPartyUniqueName: string
  Title: Contact

  Read Only: true

  Maximum Length: 900

  The name of the interaction contact.
• 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 if the interaction reference has been deleted.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  A brief description of the interaction.
• DirectionCd: string
  Title: Direction

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_INBOUND

  The code indicating whether the interaction is inbound or outbound.
• EndTime: string (date-time)
  Title: End Time

  Read Only: true

  The date and time when the interaction ends.
• 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 of reference for an interaction that was imported.
• 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 name of the resource who is an internal interaction owner associated with the interaction, such as a service agent.
• 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 associated with 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 interaction queue.
• ReferenceId: integer (int64)
  Title: Reference ID

  Read Only: true

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

  Read Only: true

  The date and time when the interaction starts.
• StatusCd: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_OPEN

  The code indicating the status of the interaction. A list of accepted values is defined in the lookup ORA_SVC_IM_STATUS_CD.
• 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 if the interaction is the top level interaction in the hierarchy.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the interaction reference has been 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":"A brief description of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The date and time when the interaction ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether the interaction is inbound or outbound.",
            "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 name of the display channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":900,
            "type":"string",
            "description":"The name of the interaction account.",
            "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 if the interaction is the top level interaction in the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the interaction reference has been 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 service request interaction reference.",
            "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 name of the resource who is an internal interaction owner associated with the interaction, such as a service agent.",
            "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 interaction account.",
            "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 interaction contact.",
            "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 interaction queue.",
            "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 code indicating the status of the interaction. A list of accepted values is defined in the lookup ORA_SVC_IM_STATUS_CD.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_OPEN",
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The original system of reference for an interaction that was imported.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The date and time when the interaction starts.",
            "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 interaction contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the interaction reference has been 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 associated with the interaction.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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-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 : serviceRequests-srMilestone-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates that the 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 comments the agent made about the milestone. For example, why the due date was overridden.
• CompletionDate: string (date-time)
  Title: Completion Date

  The date when the milestone was completed.
• ComplianceFlag: boolean
  Title: Compliance

  Maximum Length: 1

  Default Value: true

  Indicates whether the milestone is compliant or not. The default value is true.
• CoverageId: integer (int64)
  Title: Coverage ID

  The unique identifier of the service request coverage.
• 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 milestone was created.
• DelayTime: integer (int64)
  Title: Delay Time

  The amount of time the milestones has been delayed from the due date.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates if the milestone has been deleted.
• DueDate: string (date-time)
  Title: Due Date

  The date when the milestone is due.
• EntitlementId: integer
  The unique identifier of the entitlement for the milestone.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the milestone 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.
• MilestoneLabel: string
  Title: Name

  Read Only: true

  Maximum Length: 255

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

  Maximum Length: 30

  The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.
• 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 condition of the milestone when it pauses.
• SrAssigneePartyId: integer
  Title: Assigned to Party ID

  The unique identifier of the resource assigned to the service request.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request.
• SrMilestoneHistory: array Milestone Codes
  Title: Milestone Codes

  The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.
• SrMilestoneId: integer (int64)
  Title: Milestone ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 1000

  The condition of the milestone when it 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 to complete the milestone after the service request is restored from a 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 if the milestone has been updated.
• WarnedFlag: boolean
  Title: Warned

  Maximum Length: 1

  Default Value: false

  Indicates whether the milestone has 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 milestone was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WarnedFlag":{
            "title":"Warned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone has 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 condition of the milestone when it starts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement for the milestone.",
            "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 to complete the milestone after the service request is restored from a 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 milestone.",
            "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 if the milestone has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the service request coverage.",
            "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":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when the milestone is due.",
            "format":"date-time",
            "nullable":true,
            "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
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date when the milestone was 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 code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MilestoneLabel":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The display 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 identifier of the resource assigned to the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The comments the agent made about the milestone. For example, why the due date was overridden.",
            "nullable":true,
            "x-queryable":true
        },
        "PauseConditionLabel":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"The condition of the milestone when it pauses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayTime":{
            "title":"Delay Time",
            "type":"integer",
            "description":"The amount of time the milestones has been delayed from the due date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrMilestoneHistory":{
            "title":"Milestone Codes",
            "type":"array",
            "description":"The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srMilestone-SrMilestoneHistory-item-response"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the milestone is active.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the milestone has been deleted.",
            "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.",
            "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":"Indicates whether the milestone is compliant or not. The default value is true.",
            "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 milestone 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 : Milestone Codes

Type: array

Title: Milestone Codes

The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.

Show Source

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

{
    "title":"Milestone Codes",
    "type":"array",
    "description":"The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srMilestone-SrMilestoneHistory-item-response"
    }
}

Nested Schema : serviceRequests-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: Comments

  Maximum Length: 400

  The comments the agent made about the milestone. For example, why the due date was overridden.
• 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 milestone 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.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the millstone history 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 code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.
• OverriddenDueDate: string (date-time)
  Title: Due Date

  Indicates the new due date the agent set for the milestone.
• SrMilestoneId: integer (int64)
  Title: Milestone ID

  The unique identifier of the service request milestone.
• 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 code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the milestone 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 milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryId":{
            "title":"History ID",
            "type":"integer",
            "description":"The unique identifier of the milestone history.",
            "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":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The comments the agent made about the milestone. For example, why the due date was overridden.",
            "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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OverriddenDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Indicates the new due date the agent set for the milestone.",
            "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 millstone history 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 : serviceRequests-srReferences-item-response

Type: object

Show Source

• ArticleId: string
  Title: Article ID

  Maximum Length: 64

  The unique identifier of the Oracle Knowledge Cloud Service article.
• ArticleLocale: string
  Title: Article Locale

  Maximum Length: 10

  The locale of the document, such as en_US. This attribute is valid only when ArticleId is populated.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the service request reference.
• 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 if the reference has been deleted.
• DocumentId: string
  Title: Document ID

  Read Only: true

  Maximum Length: 50

  The identifier of the document 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 service request reference 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

  The unique identifier of the object referencing the service request (SR), or referenced by the SR, such as Note, Defect, or another SR.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The code indicating the type of the object that the service request reference is associated with such as Note, Article, Defect, Other SR. A list of accepted values is defined in the lookup ORA_SVC_SR_REF_OBJECT_TYPE_CD.
• ReferenceId: integer (int64)
  Title: Reference ID

  Read Only: true

  The unique identifier of the service request reference record.
• RelationTypeCd: string
  Title: Relation Type

  Maximum Length: 30

  The type of relationship.
• ResolutionCd: string
  Title: Resolution Code

  Maximum Length: 30

  The code indicating the resolution code of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.
• 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 to which the reference is associated.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The public unique identifier of the service request.
• Subject: string
  Title: Title

  Maximum Length: 1000

  The title of the article. This attribute is valid only when ArticleId is populated.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the reference has been updated.

{
    "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 created the service request reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object referencing the service request (SR), or referenced by the SR, such as Note, Defect, or another SR.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationTypeCd":{
            "title":"Relation Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the document 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 public unique identifier of the service request.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the reference has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Subject":{
            "title":"Title",
            "maxLength":1000,
            "type":"string",
            "description":"The title of the article. This attribute is valid only when ArticleId is populated.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the reference has been updated.",
            "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 service request 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 document, such as en_US. This attribute is valid only when ArticleId is populated.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the object that the service request reference is associated with such as Note, Article, Defect, Other SR. A list of accepted values is defined in the lookup ORA_SVC_SR_REF_OBJECT_TYPE_CD.",
            "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 Oracle Knowledge Cloud Service article.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the resolution code of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request to which the reference is associated.",
            "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 reference 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 : serviceRequests-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

AssetLOV

Operation: /crmRestApi/resources/11.13.18.05/assets

The list of values for asset unique identifiers.

AssistedByHumanFlagLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating whether the human agents worked on the service request during its lifecycle. The accepted values are Y and N.

Attachment

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment

Parameters:

• SrNumber: $request.path.SrNumber

The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.

BusinessUnitsLOV

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits

The list of values for the business units associated with the logged in user.

ChannelLOV

Operation: /crmRestApi/resources/11.13.18.05/channels

Parameters:

• finder: EnabledChannelByBUAndStripeAndTypeFinder%3BChannelTypeCd%3D{ChannelTypeCd}%2CStripeCd%3D{StripeCd}%2CBUOrgId%3D{BUOrgId}

The list of values for service channels.

ChannelTypeCdLookup

Operation: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV

Parameters:

• finder: IsInteractiveFinder

The list of values for channel types such as email, phone, social, and so on.

CustomerPickerVO

Operation: /crmRestApi/resources/11.13.18.05/accounts

The list of values for account party unique name.

GeographyLovPVO

Operation: /crmRestApi/resources/11.13.18.05/geoZones

The list of values indicating the service zone of the service request.

HandledByAIFlagLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating whether the service request was handled by automation agents during its lifecycle. The accepted values are Y and N.

IBAssetLocationTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CSE_CURRENT_LOC_CONTEXT

The list of values for the installed base asset location.

InternalPriorityLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_INT_PRIORITY_CD

The list of values for the internal priority of the service request such as High, Normal, Low, and so on.

LanguageCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/languagesLOV

The list of values for the language on the service request.

LoyaltyMemberIdLOV

The list of values containing the names of the loyalty members.

NetworkTypeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE

The list of values for the social networks.

OwnerTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_OWNER_TYPE_CD

The list of values for the service request owner type such as Customer and Partner.

PartnerAccountLOV

Operation: /crmRestApi/resources/11.13.18.05/partners

The list of values for the partner account unique names.

PrimaryContactLOV

Operation: /crmRestApi/resources/11.13.18.05/contacts

The list of values for the contact unique names.

ProblemCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_PROBLEM_TYPE_CD

The list of values reserved for future use.

ProductGroupLOV

Operation: /crmRestApi/resources/11.13.18.05/catalogProductGroups

The list of values for product group names.

ProductInventoryItemLOV

Operation: /crmRestApi/resources/11.13.18.05/catalogProductItems

The list of values for product descriptions.

QueueVO

Operation: /crmRestApi/resources/11.13.18.05/queues

Parameters:

• finder: QueueEnabledFinder

The list of values for service request queues.

ResolutionCdLookup

Operation: /crmRestApi/resources/11.13.18.05/serviceDependentLookupsLOV

Parameters:

• finder: SrResolutionCdFinder%3BBindChildLookupType%3DORA_SVC_SR_RESOLUTION_CD%2CBindParentLookupType%3DORA_SVC_RESOLVE_OUTCOME_CD%2CBindParentLookupCode%3D{ResolveOutcomeCd}

The list of values for resolution code of a service request such as Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on.

ResolveOutcomeCdLookup

Operation: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups

Parameters:

• finder: IsEnabledFinder

The list of values for outcome of the service request. The accepted values are defined in the lookup type ORA_SVC_RESOLVE_OUTCOME_CD.

ResolvedByAIFlagLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating whether the service request was resolved with the help of automation agents. The accepted values are Y and N.

ResourcePickerLOV

Operation: /crmRestApi/resources/11.13.18.05/resources

The list of values the service request assignee.

SearchFilterLookupPVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_SEARCH_REC_SET_CD

The list of values for record sets.

SeverityCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_SEVERITY_CD

The list of values for the severity of a service request such as severity 1, severity 2, and so on.

SourceCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD

The list of values for the source of the service request such as Agent_UI, Customer_UI, API, and so on.

SrCategoryLOV

Operation: /crmRestApi/resources/11.13.18.05/categories

Parameters:

• finder: CategoryEnabledFinder

The list of values for category codes.

SrStatusCdLookup

Operation: /crmRestApi/resources/11.13.18.05/serviceRequestStatusesLOV

Parameters:

• finder: IsEnabledFinder%3BBindChildLookupType%3DORA_SVC_SR_STATUS_CD%2CBindParentLookupType%3DORA_SVC_SR_STATUS_TYPE_CD

The list of values for the status code of the service request such as New, In Progress, Waiting, Resolved, Closed, and so on.

StatusTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_STATUS_TYPE_CD

The list of values for the status type of the service request such as New, In Progress, Waiting, Resolved, Closed.

TimezoneVO

Operation: /fscmRestApi/resources/11.13.18.05/timezonesLOV

Parameters:

• finder: EnabledFinder

TimezoneCode LOV

TransferReasonCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_TRANSFER_REASON

The list of values for the transfer reason of the service request such as Incorrectly Routed, Workload Balancing, SR Owner Unavailable, and so on.

YesNoLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating whether the service request was created using a private social network channel. The accepted values are Y and N.

activities

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities

Parameters:

• SrNumber: $request.path.SrNumber

The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.

addresses

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/addresses

Parameters:

• SrNumber: $request.path.SrNumber

A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.

channelCommunication

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication

Parameters:

• SrNumber: $request.path.SrNumber

The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.

contacts

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts

Parameters:

• SrNumber: $request.path.SrNumber

The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.

getSrMilestoneDiagnostics

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/getSrMilestoneDiagnostics

Parameters:

• SrNumber: $request.path.SrNumber

Returns the service request milestone diagnostics report results for the specified service request.

messages

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages

Parameters:

• SrNumber: $request.path.SrNumber

The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".

processSrMilestones

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/processSrMilestones

Parameters:

• SrNumber: $request.path.SrNumber

Evaluates service request and applies any required changes to its milestones.

resourceMembers

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers

Parameters:

• SrNumber: $request.path.SrNumber

Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.

sendEmailForSrMessage

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/sendEmailForSrMessage

Parameters:

• SrNumber: $request.path.SrNumber

This method lets you send an email to the recipients of the service request message for the specified message identifier.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions

Parameters:

• SrNumber: $request.path.SrNumber

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

srInteractionReferences

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences

Parameters:

• SrNumber: $request.path.SrNumber

The interaction references resource is used to view the relationship between an interaction and a service request.

srMilestone

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone

Parameters:

• SrNumber: $request.path.SrNumber

The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.

srReferences

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences

Parameters:

• SrNumber: $request.path.SrNumber

The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.

srTags

Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags

Parameters:

• SrNumber: $request.path.SrNumber

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

Back to Top

Examples

The following example shows how to create a new service request by submitting a POST request on the REST resource.

Example of Request Header

The following shows an example of the request header.

POST /crmRestApi/resources/11.13.18.05/serviceRequests

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"Title":"REST API - created time - 2016/8/19 12:20"
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 Created
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

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

{
"SrId": 300100091257952
"SrNumber": "SR0000029003"
"Title": "REST API - created time - 2016/8/19 12:20"
"ProblemDescription": null
"SeverityCd": "ORA_SVC_SEV3"
"AssigneeResourceId": null
"AssigneePartyId": null
"AssigneePersonName": null
"AssigneeEmailAddress": null
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-08-19T03:56:26-07:00"
"LastUpdateDate": "2016-08-19T03:56:26-07:00"
"LastUpdateLogin": "3A2BCDBFB28DA5F0E053780CF10A9DA7"
"LastUpdatedBy": "SALES_ADMIN"
"LastUpdatedByDisplayName": null
"AccountPartyId": null
"AccountPartyUniqueName": null
"PartnerAccountPartyId": null
"PartnerAccountPartyName": null
"PartnerAccountPartyUniqueName": null
"OwnerTypeCd": "ORA_SVC_CUSTOMER"
"PrimaryContactPartyId": null
"PrimaryContactPartyUniqueName": null
"PrimaryContactFormattedPhoneNumber": null
"CategoryId": null
"ClosedDate": null
"CorpCurrencyCode": null
"CurcyConvRateType": null
"CurrencyCode": null
"OpenDate": "2016-08-19T03:56:26-07:00"
"ReportedByPartyId": 100010025532672
"ReportedByPartyUniqueName": null
"ProblemCd": null
"ProdGroupId": null
"ProdGroupName": null
"InventoryItemId": null
"InventoryOrgId": null
"ProductItemOrgId": null
"ProductItemDescription": null
"ProductItemNumber": null
"AssetId": null
"AssetSerialNumber": null
"QueueId": null
"LastReopenDate": null
"LastResolvedDate": null
"ResolutionCd": null
"SourceCd": null
"ChannelTypeCd": null
"StatusCd": "ORA_SVC_NEW"
"InternalPriorityCd": null
"LanguageCd": null
"StatusTypeCd": "ORA_SVC_NEW"
"SrCreatedBy": "SALES_ADMIN"
"QueueName": null
"CriticalFlag": false
"OriginalSystemReference": "SR0000029003"
"CategoryName": null
"SrLastUpdateDate": "2016-08-19T03:56:26-07:00"
"SrLastUpdateLogin": "3A2BCDBFB28DA5F0E053780CF10A9DA7"
"SrLastUpdatedBy": "SALES_ADMIN"
"RecordSet": null
"links": 
[
28]
0:  
{
"rel": "self"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000029003"
"name": "serviceRequests"
"kind": "item"
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000177040000000A737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
-
}
-
1:  
{
"rel": "canonical"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000029003"
"name": "serviceRequests"
"kind": "item"
}
-
2:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000029003/lov/SearchFilterLookupPVO"
"name": "SearchFilterLookupPVO"
"kind": "collection"
}
-
3:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000029003/lov/ResourcePickerLOV"
"name": "ResourcePickerLOV"
"kind": "collection"
}
-
4:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000029003/lov/PartnerAccountLOV"
"name": "PartnerAccountLOV"
"kind": "collection"
}
-
5:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000029003/lov/QueueVO"
"name": "QueueVO"
"kind": "collection"
}
-
. . .
-
}

Back to Top