Get all cases
get
/crmRestApi/resources/11.13.18.05/cases
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- CaseByCaseNumber: Finds a case with the specified case number.
Finder Variables:- CaseNumber; string; The alternate key identifier of the case.
- CaseListMyCaseTeamCasesFinder: Find all the cases assigned to my team.
Finder Variables: - CasesCreatedByMeFinder: Find all the cases created by me.
Finder Variables: - MyCasesByStatusFinder: Finds all the cases assigned to me.
Finder Variables:- StatusCd; string; Finds all the cases assigned to me and are of a particular status. For example, ORA_SVC_NEW or ORA_SVC_REOPENED.
- MyCasesFinder: Find all the cases assigned to me.
Finder Variables: - PrimaryKey: Finds a case with the specified primary key.
Finder Variables:- CaseId; integer; The unique identifier of the case.
- CaseByCaseNumber: Finds a case with the specified case number.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AssigneePartyName; string; The name of the party associated with the case assignee.
- AssigneePartyNumber; string; The alternate key identifier of the case assignee.
- AssigneeResourceId; integer; The unique identifier of the resource assigned to the case. For example, a support engineer.
- BUOrgId; integer; The unique identifier of the business unit name associated with the case.
- BusinessUnitName; string; The name of the business unit associated with the case.
- CaseCategoryId; integer; The unique identifier of the case category.
- CaseCreatedBy; string; The user who created the case.
- CaseCreationDate; string; The date and time when the case was created.
- CaseId; integer; The unique identifier of the case.
- CaseLastUpdateDate; string; The date and time when the case was last updated.
- CaseLastUpdateLogin; string; The login details of the user who last updated the case.
- CaseLastUpdatedBy; string; The user who last updated the case.
- CaseNumber; string; The alternate key identifier of the case.
- CaseTypeCd; string; The lookup code that indicates the type of case.
- CaseTypeCdMeaning; string; The display value corresponding to the case type lookup code for the case.
- CategoryName; string; The name of the category associated with the case.
- ClosedDate; string; The date when the case was closed.
- CreatedBy; string; The user who created the case.
- CreatedByPartyId; integer; The unique identifier of the user who created the case in the system.
- CreatedByPartyName; string; The party name of the user who created the case in the system.
- CreatedByPartyNumber; string; The alternate key identifier of the user who created the case in the system.
- CreationDate; string; The date and time when the case was created.
- Description; string; A brief description of the case.
- LastClosedDate; string; The date when the case was last closed.
- LastReopenDate; string; The date when the case was last reopened.
- LastUpdateDate; string; The date and time when the case was last updated.
- LastUpdatedBy; string; The user who last updated the case.
- LastUpdatedByPartyId; integer; The unique identifier of the party of the user who last updated the case.
- LastUpdatedByPartyName; string; The party name of the user who last updated the case.
- LastUpdatedByPartyNumber; string; The alternate key identifier of the user who last updated the case.
- OpenDate; string; The date when the case was opened, in case the case is approved.
- PrimaryContactPartyId; integer; The unique identifier of the primary contact for the case.
- PrimaryContactPartyName; string; The name of the primary contact party.
- PrimaryContactPartyNumber; string; The alternate key identifier of the primary contact party.
- PrimaryHouseholdPartyId; integer; The unique identifier of the primary household for the case.
- PrimaryHouseholdPartyName; string; The name of the primary household party.
- PrimaryHouseholdPartyNumber; string; The alternate key identifier of the primary household party.
- PriorityCd; string; The code indicating the priority of the case. For example, ORA_SVC_HIGH, ORA_SVC_LOW, or ORA_SVC_MEDIUM.
- PriorityCdMeaning; string; The display value corresponding to the priority lookup code for the case.
- QueueId; integer; The unique identifier of the queue that the case is assigned to.
- QueueName; string; The name of the queue associated with the case.
- QueueNumber; string; The alternate key identifier of the queue associated with the case.
- ReportedByPartyId; integer; The unique identifier of the person who reported the case.
- ReportedByPartyName; string; The party name of the person who reported the case.
- ReportedByPartyNumber; string; The alternate key identifier of the person who reported the case.
- SensitivityCd; string; The code indicating the sensitivity of the case record from the security point of view. For example, ORA_SVC_CONFIDENTIAL, when security is required to control access to a case record, or ORA_SVC_NORMAL, when no special security is required to control access to case record.
- SensitivityCdMeaning; string; The display value corresponding to the sensitivity lookup code for the case.
- SourceCd; string; The code indicating how the case was created or entered into the system. For example, ORA_SVC_API, ORA_SVC_AGENT_UI, or ORA_SVC_MOBILE.
- SourceCdMeaning; string; The display value corresponding to the source lookup code for the case.
- StatusCd; string; The code indicating the status of the case. Such as, ORA_SVC_CANCELED, ORA_SVC_CLOSED, ORA_SVC_REOPENED, ORA_SVC_ELIGIBILITY_END, ORA_SVC_INCOMPLETE, ORA_SVC_NEW, ORA_SVC_SUSPENDED, or ORA_SVC_WITHDRAWN.
- StatusCdMeaning; string; The display value corresponding to the status lookup code for the case.
- StatusTypeCd; string; The code indicating the status type of the case. Such as, ORA_SVC_ACTIVE, when a case is assigned to a case worker and is being actively worked on, ORA_SVC_CLOSED, when a case is closed, ORA_SVC_INACTIVE, when a case is not being worked on, ORA_SVC_RESOLVED, when a case is resolved, ORA_SVC_SUSPENDED. when a case is suspended or paused due to lack of data.
- StatusTypeCdMeaning; string; The display value corresponding to the status type lookup code for the case.
- StripeCd; string; The stripe code for the case.
- Title; string; The title of the case.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : cases
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-item-response
Type:
Show Source
object
-
AssigneePartyName: string
Title:
Assignee Party Name
Maximum Length:360
The name of the party associated with the case assignee. -
AssigneePartyNumber: string
Title:
Assignee Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the case assignee. -
AssigneeResourceId: integer
(int64)
Title:
Assignee Resource ID
The unique identifier of the resource assigned to the case. For example, a support engineer. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, update, and delete an attachment. -
BUOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the business unit name associated with the case. -
BusinessUnitName: string
Title:
Business Unit Name
Maximum Length:240
The name of the business unit associated with the case. -
CaseCategoryId: integer
(int64)
Title:
Case Category ID
The unique identifier of the case category. -
caseContacts: array
Case Contacts
Title:
Case Contacts
The case contacts resource is used to view, create, update, and delete many-to-many relationships between cases and associated contacts. -
CaseCreatedBy: string
Title:
Case Created By
Maximum Length:64
The user who created the case. -
CaseCreationDate: string
(date-time)
Title:
Case Creation Date
The date and time when the case was created. -
caseHouseholds: array
Case Households
Title:
Case Households
The case households resource is used to view, create, update, and delete many-to-many relationships between cases and associated households. -
CaseId: integer
(int64)
Title:
Case ID
Read Only:true
The unique identifier of the case. -
CaseLastUpdateDate: string
(date-time)
Title:
Case Last Update Date
The date and time when the case was last updated. -
CaseLastUpdatedBy: string
Title:
Case Last Updated By
Maximum Length:64
The user who last updated the case. -
CaseLastUpdateLogin: string
Title:
Case Last Update Login
Maximum Length:32
The login details of the user who last updated the case. -
caseMessages: array
Case Messages
Title:
Case Messages
The case messages resource is used to view, create, update, and delete information about every communication update associated with the case. -
CaseNumber: string
Title:
Case Number
Maximum Length:30
The alternate key identifier of the case. -
caseOpportunities: array
Case Opportunities
Title:
Case Opportunities
The opportunities resources indicates the one-to-many relationships between the case and associated opportunities. -
caseResources: array
Case Resources
Title:
Case Resources
Case resources is used to view, create, update, and delete many-to-many relationships between cases and associated resources. -
CaseTypeCd: string
Title:
Case Type Code
Maximum Length:30
The lookup code that indicates the type of case. -
CaseTypeCdMeaning: string
Title:
Case Type Value
Maximum Length:255
The display value corresponding to the case type lookup code for the case. -
CategoryName: string
Title:
Category Name
Maximum Length:400
The name of the category associated with the case. -
ClosedDate: string
(date-time)
Title:
Closed Date
The date when the case was closed. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the case. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the case. -
CreatedByPartyId: integer
(int64)
Title:
Created by Party ID
The unique identifier of the user who created the case in the system. -
CreatedByPartyName: string
Title:
Created by Party Name
Read Only:true
Maximum Length:360
The party name of the user who created the case in the system. -
CreatedByPartyNumber: string
Title:
Created by Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the user who created the case in the system. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the case was created. -
CurcyConvRateType: string
Title:
Currency Rate
Maximum Length:30
The currency conversion rate type associated with the case. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the case. 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. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the case can be deleted. -
Description: string
Title:
Description
Maximum Length:1000
A brief description of the case. -
LastClosedDate: string
(date-time)
Title:
Last Closed Date
The date when the case was last closed. -
LastReopenDate: string
(date-time)
Title:
Last Reopen Date
The date when the case was last reopened. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the case was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the case. -
LastUpdatedByPartyId: integer
(int64)
Title:
Last Updated by Party
The unique identifier of the party of the user who last updated the case. -
LastUpdatedByPartyName: string
Title:
Last Updated by Party Name
Read Only:true
Maximum Length:360
The party name of the user who last updated the case. -
LastUpdatedByPartyNumber: string
Title:
Last Updated by Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the user who last updated the case. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpenDate: string
(date-time)
Title:
Open Date
The date when the case was opened, in case the case is approved. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
The unique identifier of the primary contact for the case. -
PrimaryContactPartyName: string
Title:
Primary Contact Party Name
Maximum Length:360
The name of the primary contact party. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the primary contact party. -
PrimaryHouseholdPartyId: integer
(int64)
Title:
Primary Household Party ID
The unique identifier of the primary household for the case. -
PrimaryHouseholdPartyName: string
Title:
Primary Household Party Name
Maximum Length:360
The name of the primary household party. -
PrimaryHouseholdPartyNumber: string
Title:
Primary Household Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the primary household party. -
PriorityCd: string
Title:
Priority
Maximum Length:30
The code indicating the priority of the case. For example, ORA_SVC_HIGH, ORA_SVC_LOW, or ORA_SVC_MEDIUM. -
PriorityCdMeaning: string
Title:
Priority Value
Maximum Length:255
The display value corresponding to the priority lookup code for the case. -
QueueId: integer
(int64)
Title:
Queue ID
The unique identifier of the queue that the case is assigned to. -
QueueName: string
Title:
Queue
Maximum Length:400
The name of the queue associated with the case. -
QueueNumber: string
Title:
Queue Number
Maximum Length:30
The alternate key identifier of the queue associated with the case. -
ReportedByPartyId: integer
(int64)
Title:
Reported by Party ID
The unique identifier of the person who reported the case. -
ReportedByPartyName: string
Title:
Reported by Party Name
Read Only:true
Maximum Length:360
The party name of the person who reported the case. -
ReportedByPartyNumber: string
Title:
Reported by Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the person who reported the case. -
SensitivityCd: string
Title:
Sensitivity
Maximum Length:30
The code indicating the sensitivity of the case record from the security point of view. For example, ORA_SVC_CONFIDENTIAL, when security is required to control access to a case record, or ORA_SVC_NORMAL, when no special security is required to control access to case record. -
SensitivityCdMeaning: string
Title:
Sensitivity Value
Maximum Length:255
The display value corresponding to the sensitivity lookup code for the case. -
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. -
SourceCd: string
Title:
Source
Maximum Length:30
The code indicating how the case was created or entered into the system. For example, ORA_SVC_API, ORA_SVC_AGENT_UI, or ORA_SVC_MOBILE. -
SourceCdMeaning: string
Title:
Source Value
Maximum Length:255
The display value corresponding to the source lookup code for the case. -
StatusCd: string
Title:
Status
Maximum Length:30
Default Value:ORA_SVC_NEW
The code indicating the status of the case. Such as, ORA_SVC_CANCELED, ORA_SVC_CLOSED, ORA_SVC_REOPENED, ORA_SVC_ELIGIBILITY_END, ORA_SVC_INCOMPLETE, ORA_SVC_NEW, ORA_SVC_SUSPENDED, or ORA_SVC_WITHDRAWN. -
StatusCdMeaning: string
Title:
Status Value
Maximum Length:255
The display value corresponding to the status lookup code for the case. -
StatusTypeCd: string
Title:
Status Type
Maximum Length:30
Default Value:ORA_SVC_ACTIVE
The code indicating the status type of the case. Such as, ORA_SVC_ACTIVE, when a case is assigned to a case worker and is being actively worked on, ORA_SVC_CLOSED, when a case is closed, ORA_SVC_INACTIVE, when a case is not being worked on, ORA_SVC_RESOLVED, when a case is resolved, ORA_SVC_SUSPENDED. when a case is suspended or paused due to lack of data. -
StatusTypeCdMeaning: string
Title:
Status Type Value
Maximum Length:255
The display value corresponding to the status type lookup code for the case. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The stripe code for the case. -
Title: string
Title:
Title
Maximum Length:400
The title of the case. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the record can be updated.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, update, and delete an attachment.
Show Source
Nested Schema : Case Contacts
Type:
array
Title:
Case Contacts
The case contacts resource is used to view, create, update, and delete many-to-many relationships between cases and associated contacts.
Show Source
Nested Schema : Case Households
Type:
array
Title:
Case Households
The case households resource is used to view, create, update, and delete many-to-many relationships between cases and associated households.
Show Source
Nested Schema : Case Messages
Type:
array
Title:
Case Messages
The case messages resource is used to view, create, update, and delete information about every communication update associated with the case.
Show Source
Nested Schema : Case Opportunities
Type:
array
Title:
Case Opportunities
The opportunities resources indicates the one-to-many relationships between the case and associated opportunities.
Show Source
Nested Schema : Case Resources
Type:
array
Title:
Case Resources
Case resources is used to view, create, update, and delete many-to-many relationships between cases and associated resources.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : cases-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for the exclusive use by the attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the document from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a topology manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Attachment Previews
Type:
array
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-Attachments-AttachmentsPreview-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : cases-caseContacts-item-response
Type:
Show Source
object
-
CaseContactId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the case contact. -
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Maximum Length:30
The alternate key identifier of the case. -
ContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the contact party. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the contact for the case. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the case contact was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the case contact. 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. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the case contact can be deleted. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the contact. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the contact. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the contact for the case was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the contact for the case. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the contact for the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party. -
PartyName: string
Title:
Party Name
Maximum Length:360
The name of the party. -
PersonId: integer
(int64)
Title:
Person ID
The unique identifier of a person who is an employee on the case. -
PrimaryFlag: boolean
Title:
Primary Contact
Read Only:true
Indicates whether the contact is the primary contact for the case. -
RelationshipCd: string
Title:
Relationship Code
Maximum Length:30
The code indicating the relation of the contact to the case. For example, ORA_SVC_BENEFICIARY, contact who is the beneficiary of the case, ORA_SVC_CHILD, contact who is a legal child of the applicant, ORA_SVC_DEPENDENT, contact is dependent on the applicant, ORA_SVC_GUARDIAN, contact is a legal guardian of the applicant, ORA_SVC_LAWYER, contact is an attorney by profession dealing with the case, ORA_SVC_PARENT, contact is the legal parent of the applicant, ORA_SVC_PERPETRATOR, contact who carries out a criminal, or harmful act, ORA_SVC_REFERRAL, contact who refers a service provider, ORA_SVC_REPORTER, contact who reports an incident, ORA_SVC_SERVICE_PROVIDER, contact or a business entity who is rendering specific services or benefits to the applicant, ORA_SVC_SIBLING, contact who is the legal sibling of the applicant, ORA_SVC_SPOUSE, contact who is a spouse of the applicant, or ORA_SVC_VICTIM, contact who is affected by an incident or an event, -
RelationshipCdMeaning: string
Title:
Relationship Value
Maximum Length:255
The display value corresponding to the relationship lookup code for the case contact. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the case contact can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-caseHouseholds-item-response
Type:
Show Source
object
-
CaseHouseholdId: integer
(int64)
Title:
Household ID
Read Only:true
The unique identifier of the case household. -
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Maximum Length:30
The alternate key identifier of the case. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the household for the case. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the case household was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the case household. 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. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the record can be deleted. -
HouseholdName: string
Title:
Household Name
Maximum Length:360
The name of the household. -
HouseholdPartyNumber: string
Title:
Household Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the household party. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the household for the case was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the household for the case. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the household for the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party. -
PrimaryFlag: boolean
Title:
Primary Household
Read Only:true
Indicates whether the household is the primary household for the case. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the record can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-caseMessages-item-response
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, update, and delete an attachment. -
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Maximum Length:30
The alternate key identifier of the case. -
Content: string
(byte)
Title:
Content
The content of the message that is not an attachment. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the message for the case. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the case message was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the case message. 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. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the record can be deleted. -
LastEditedDate: string
(date-time)
Title:
Last Update Date
The date when the case message was last edited. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the message for the case was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the message for the case. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the message for the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageCreatedBy: string
Title:
Message Created By
Maximum Length:64
The user who created the case message. -
MessageCreationDate: string
(date-time)
Title:
Message Creation Date
The date and time when the case message was created. -
MessageId: integer
(int64)
Title:
Message ID
The unique identifier of the message. -
MessageLastUpdateDate: string
(date-time)
Title:
Message Last Update Date
The date and time when the case message was last updated. -
MessageLastUpdatedBy: string
Title:
Message Last Updated By
Maximum Length:64
The user who last updated the case message. -
MessageLastUpdateLogin: string
Title:
Message Last Update Login
Maximum Length:32
The application login id of the user who last updated the case message. -
MessageNumber: string
Title:
Message Number
Maximum Length:30
The alternate key identifier of the message. -
MessageTypeCd: string
Title:
Message Type
Maximum Length:30
Default Value:ORA_SVC_NOTE
The code indicating the type of the message, such as internal or external. -
MessageTypeCdMeaning: string
Title:
Message Type Value
Maximum Length:255
The display value corresponding to the message type lookup code for the case message. -
OriginationDate: string
(date-time)
Title:
Origination Date
The date when the message originated, or was posted. -
ParentMessageId: integer
(int64)
Title:
Parent Message
The unique identifier of the parent message. -
PostedByPartyId: integer
(int64)
Title:
Posting Party ID
The unique identifier of the user party who posted the message. -
PostedByPartyName: string
Title:
Posted by Party Name
Read Only:true
Maximum Length:360
The name of the party who posted the message. -
PostedByPartyNumber: string
Title:
Posting Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the user party who posted the message. -
RichTextFlag: boolean
Title:
Rich Text Format
Maximum Length:1
Default Value:true
Indicates whether the message content is in rich text format The values are Y or N. -
SourceCd: string
Title:
Source
Maximum Length:30
The code indicating how the message was entered into the system. For example, ORA_SVC_API, case message was created through REST API, ORA_SVC_AGENT_UI, case message was created in the UI), or ORA_SVC_MOBILE, case message was created through a mobile device. -
SourceCdMeaning: string
Title:
Source Value
Maximum Length:255
The display value corresponding to the source lookup code for the case message. -
StatusCd: string
Title:
Status Code
Maximum Length:30
Default Value:ORA_SVC_COMMITTED
The code indicating the status of the message. For example, ORA_SVC_COMMITTED, indicates that the message is committed, or NULL. -
StatusCdMeaning: string
Title:
Status Value
Maximum Length:255
The display value corresponding to the status lookup code for the case message. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the record can be updated. -
VisibilityCd: string
Title:
Visibility
Maximum Length:30
Default Value:ORA_SVC_INTERNAL
The code indicating the visibility level of the case message. For example, ORA_SVC_EXTERNAL, case message is visible to internal and external users, or ORA_SVC_INTERNAL, case message is visible to internal users only. -
VisibilityCdMeaning: string
Title:
Visibility Value
Maximum Length:255
The display value corresponding to the visibility lookup code for the case message.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, update, and delete an attachment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-caseMessages-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for the exclusive use by the attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the document from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a topology manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Attachment Previews
Type:
array
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-caseMessages-Attachments-AttachmentsPreview-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-caseOpportunities-item-response
Type:
Show Source
object
-
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Read Only:true
Maximum Length:30
The alternate unique identifier of the case. -
CaseOpportunityId: integer
(int64)
Title:
Case Opportunity ID
Read Only:true
The unique identifier of the opportunity associated with the case. -
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 when the record was created. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the record can be deleted by the current user. -
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:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the case opportunity. -
OptyName: string
Title:
Opportunity Name
Maximum Length:275
The opportunity name of the case opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The alternate unique identifier of the case opportunity. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the record can be updated by the current user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-caseResources-item-response
Type:
Show Source
object
-
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Maximum Length:30
The alternate key identifier of the case. -
CaseResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier of the case resource. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource for the case. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the case resource was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the case resource. 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. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the record can be deleted. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the contact who created the resource. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the user who created the resource. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource for the case was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource for the case. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login session of the user who last updated the resource for the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates whether the resource is the owner of the case. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party. -
ResourceName: string
Title:
Resource Name
Maximum Length:360
The name of the resource. -
ResourcePartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the party. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the record can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-smartActions-item-response
Type:
Show Source
object
-
ActionContextParameters: string
Title:
Action Context Parameters
Maximum Length:1000
Determines the context when a smart action is applicable. -
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ActionSource: string
Title:
Action Source
Maximum Length:512
Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the action is active or inactive. Inactive actions are not returned to client applications under any circumstance. 'True' indicates the smart action is active. -
ApplicationRoles: string
Title:
Application Roles
Maximum Length:2000
The application roles associated with the smart action. -
Condition: string
Title:
Filter Condition
Maximum Length:1000
The boolean script evaluated at runtime to determine if the action can be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
ContextualFlag: boolean
Title:
Contextual
Maximum Length:1
Indicates the contexual flag. -
DataPrivilege: string
Title:
Data Security Privilege
Maximum Length:250
The data security privilege that the authenticated user role must be granted, in order for the action to be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The consumer friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The REST resources the Action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the Action. -
IncludedIn: string
Title:
Included In
Maximum Length:150
The View Object corresponding to the primary object the smart action is associated with. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The list of applications that this action can be used in. -
InternalFlag: boolean
Title:
Restricted
Maximum Length:1
Indicates whether the action is internal type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates whether the action can be mass processed. -
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 associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The Page Type. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates the smart suggest flag. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the Action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The attribute uniquely identifies the action with name. For internal use. - UserActionNavigation: array User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number to indicate priority of the action. -
UserActionRequestPayload: array
Payload Definitions
Title:
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
Path Parameter Definitions
Title:
Path Parameter Definitions
The path parameters definitions 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. -
UserPrivilege: string
Title:
User Security Privilege
Maximum Length:4000
The User Security Privilege.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payload Definitions
Type:
array
Title:
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
Nested Schema : Path Parameter Definitions
Type:
array
Title:
Path Parameter Definitions
The path parameters definitions 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
Nested Schema : cases-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
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 smart suggest path. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cases-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
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:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- copyCaseAttachments
-
This method lets you provide a list of attachments to be copied to a particular case. It will create new copy of each attachment.
Examples
The following example shows how to get all cases by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cases
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AssigneeResourceId": null, "BUOrgId": 204, "CaseCategoryId": null, "CaseCreatedBy": "AUTOUICASE1", "CaseCreationDate": "2021-08-25T23:47:35+00:00", "CaseId": 300100216949243, "CaseLastUpdateDate": "2021-08-25T23:47:35.001+00:00", "CaseLastUpdateLogin": "CA5FA16623618065E05323EAF40A8D90", "CaseLastUpdatedBy": "AUTOUICASE1", "CaseNumber": "CDRM_5003", "ClosedDate": null, "CorpCurrencyCode": null, "CreatedBy": "AUTOUICASE1", "CreatedByPartyId": 300100112109025, "CreationDate": "2021-08-25T23:47:35+00:00", "CurcyConvRateType": null, "CurrencyCode": null, "Description": null, "LastClosedDate": null, "LastReopenDate": null, "LastUpdateDate": "2021-08-25T23:47:53.735+00:00", "LastUpdateLogin": "CA5F9CD8F6178063E05323EAF40A4F68", "LastUpdatedBy": "AUTOUICASE1", "LastUpdatedByPartyId": 300100112109025, "OpenDate": "2021-08-25T23:47:36.181+00:00", "PrimaryContactPartyId": null, "PrimaryHouseholdPartyId": null, "PriorityCd": null, "QueueId": null, "ReportedByPartyId": 300100112109025, "SensitivityCd": null, "SourceCd": null, "StatusCd": "ORA_SVC_NEW", "StatusTypeCd": "ORA_SVC_ACTIVE", "StripeCd": "ORA_SVC_CRM", "Title": "JETAutoRestCase_202173_164725548", "AssigneePartyName": null, "AssigneePartyNumber": null, "BusinessUnitName": "Vision Operations", "CategoryName": null, "PrimaryContactPartyName": null, "PrimaryContactPartyNumber": null, "PrimaryHouseholdPartyName": null, "PrimaryHouseholdPartyNumber": null, "QueueName": null, "QueueNumber": null, "ReportedByPartyName": "AUTOUICASE1 svc", "ReportedByPartyNumber": "CDRM_674216", "LastUpdatedByPartyName": "AUTOUICASE1 svc", "LastUpdatedByPartyNumber": "CDRM_674216", "CreatedByPartyName": "AUTOUICASE1 svc", "CreatedByPartyNumber": "CDRM_674216", "DeleteFlag": true, "UpdateFlag": true, "StatusTypeCdMeaning": "Active", "PriorityCdMeaning": null, "SensitivityCdMeaning": null, "SourceCdMeaning": null, "StatusCdMeaning": "New", "CaseTypeCd": null, "CaseTypeCdMeaning": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_5003", "name": "cases", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678" } ... }