Jump to

• Request
• Response
• Examples

Get a case

get

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}

Request

Path Parameters

• CaseNumber(required): string
  The alternate key identifier of the case.

Query Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : cases-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseCreatedBy":{
            "title":"Case Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the case.",
            "nullable":true,
            "x-queryable":true
        },
        "OpenDate":{
            "title":"Open Date",
            "type":"string",
            "description":"The date when the case was opened, in case the case is approved.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryHouseholdPartyName":{
            "title":"Primary Household Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary household party.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CaseLastUpdateDate":{
            "title":"Case Last Update Date",
            "type":"string",
            "description":"The date and time when the case was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Rate",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCd":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryHouseholdPartyNumber":{
            "title":"Primary Household Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the primary household party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneePartyName":{
            "title":"Assignee Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the case assignee.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "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/cases-smartActions-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedByPartyId":{
            "title":"Created by Party ID",
            "type":"integer",
            "description":"The unique identifier of the user who created the case in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseTypeCdMeaning":{
            "title":"Case Type Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the case type lookup code for the case.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CaseTypeCd"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact for the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastClosedDate":{
            "title":"Last Closed Date",
            "type":"string",
            "description":"The date when the case was last closed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByPartyNumber":{
            "title":"Created by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the user who created the case in the system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SensitivityCdMeaning":{
            "title":"Sensitivity Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the sensitivity lookup code for the case.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SensitivityCd"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedByPartyName":{
            "title":"Reported by Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the person who reported the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the case.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "caseHouseholds":{
            "title":"Case Households",
            "type":"array",
            "description":"The case households resource is used to view, create, update, and delete many-to-many relationships between cases and associated households.",
            "items":{
                "$ref":"#/components/schemas/cases-caseHouseholds-item-response"
            }
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue that the case is assigned to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "StripeCd"
                ]
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the case can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the primary contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByPartyName":{
            "title":"Last Updated by Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the user who last updated the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriorityCdMeaning":{
            "title":"Priority Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the priority lookup code for the case.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PriorityCd"
                ]
            },
            "x-queryable":true
        },
        "caseResources":{
            "title":"Case Resources",
            "type":"array",
            "description":"Case resources is used to view, create, update, and delete many-to-many relationships between cases and associated resources.",
            "items":{
                "$ref":"#/components/schemas/cases-caseResources-item-response"
            }
        },
        "caseMessages":{
            "title":"Case Messages",
            "type":"array",
            "description":"The case messages resource is used to view, create, update, and delete information about every communication update associated with the case.",
            "items":{
                "$ref":"#/components/schemas/cases-caseMessages-item-response"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryHouseholdPartyId":{
            "title":"Primary Household Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary household for the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"A brief description of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "caseContacts":{
            "title":"Case Contacts",
            "type":"array",
            "description":"The case contacts resource is used to view, create, update, and delete many-to-many relationships between cases and associated contacts.",
            "items":{
                "$ref":"#/components/schemas/cases-caseContacts-item-response"
            }
        },
        "CaseLastUpdatedBy":{
            "title":"Case Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the case.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneePartyNumber":{
            "title":"Assignee Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case assignee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeResourceId":{
            "title":"Assignee Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource assigned to the case. For example, a support engineer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete an attachment.",
            "items":{
                "$ref":"#/components/schemas/cases-Attachments-item-response"
            }
        },
        "CreatedByPartyName":{
            "title":"Created by Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the user who created the case in the system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary contact party.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "AltLabel":"Primary Contact"
            },
            "x-queryable":true
        },
        "CaseLastUpdateLogin":{
            "title":"Case Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the case.",
            "nullable":true,
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceCdMeaning":{
            "title":"Source Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the source lookup code for the case.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceCd"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business unit associated with the case.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the queue associated with the case.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "caseOpportunities":{
            "title":"Case Opportunities",
            "type":"array",
            "description":"The opportunities resources indicates the one-to-many relationships between the case and associated opportunities.",
            "items":{
                "$ref":"#/components/schemas/cases-caseOpportunities-item-response"
            }
        },
        "LastUpdatedByPartyId":{
            "title":"Last Updated by Party",
            "type":"integer",
            "description":"The unique identifier of the party of the user who last updated the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusTypeCdMeaning":{
            "title":"Status Type Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the status type lookup code for the case.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusTypeCd"
                ]
            },
            "x-queryable":true
        },
        "PriorityCd":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the priority of the case. For example, ORA_SVC_HIGH, ORA_SVC_LOW, or ORA_SVC_MEDIUM.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_SVC_NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"400",
            "type":"string",
            "description":"The title of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseCreationDate":{
            "title":"Case Creation Date",
            "type":"string",
            "description":"The date and time when the case was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the queue associated with the case.",
            "nullable":false,
            "x-queryable":true
        },
        "ReportedByPartyNumber":{
            "title":"Reported by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the person who reported the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastReopenDate":{
            "title":"Last Reopen Date",
            "type":"string",
            "description":"The date when the case was last reopened.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The stripe code for the case.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SensitivityCd":{
            "title":"Sensitivity",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusTypeCd":{
            "title":"Status Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_SVC_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit name associated with the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the category associated with the case.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "AltLabel":"Category"
            },
            "x-queryable":true
        },
        "CaseCategoryId":{
            "title":"Case Category ID",
            "type":"integer",
            "description":"The unique identifier of the case category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "BUOrgId",
                    "StripeCd"
                ]
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"The date when the case was closed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CaseTypeCd":{
            "title":"Case Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code that indicates the type of case.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReportedByPartyId":{
            "title":"Reported by Party ID",
            "type":"integer",
            "description":"The unique identifier of the person who reported the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the case was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByPartyNumber":{
            "title":"Last Updated by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the user who last updated the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object cases-Attachments-item-response

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

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

• Array of: object cases-caseContacts-item-response

{
    "title":"Case Contacts",
    "type":"array",
    "description":"The case contacts resource is used to view, create, update, and delete many-to-many relationships between cases and associated contacts.",
    "items":{
        "$ref":"#/components/schemas/cases-caseContacts-item-response"
    }
}

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

• Array of: object cases-caseHouseholds-item-response

{
    "title":"Case Households",
    "type":"array",
    "description":"The case households resource is used to view, create, update, and delete many-to-many relationships between cases and associated households.",
    "items":{
        "$ref":"#/components/schemas/cases-caseHouseholds-item-response"
    }
}

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

• Array of: object cases-caseMessages-item-response

{
    "title":"Case Messages",
    "type":"array",
    "description":"The case messages resource is used to view, create, update, and delete information about every communication update associated with the case.",
    "items":{
        "$ref":"#/components/schemas/cases-caseMessages-item-response"
    }
}

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

• Array of: object cases-caseOpportunities-item-response

{
    "title":"Case Opportunities",
    "type":"array",
    "description":"The opportunities resources indicates the one-to-many relationships between the case and associated opportunities.",
    "items":{
        "$ref":"#/components/schemas/cases-caseOpportunities-item-response"
    }
}

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

• Array of: object cases-caseResources-item-response

{
    "title":"Case Resources",
    "type":"array",
    "description":"Case resources is used to view, create, update, and delete many-to-many relationships between cases and associated resources.",
    "items":{
        "$ref":"#/components/schemas/cases-caseResources-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 : 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 cases-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/cases-smartActions-item-response"
    }
}

Nested Schema : cases-Attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

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

Nested Schema : Attachment Previews

Type: array

Title: Attachment Previews

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

Show Source

• Array of: object cases-Attachments-AttachmentsPreview-item-response

{
    "title":"Attachment Previews",
    "type":"array",
    "description":"The attachments preview resource is used to preview the attachment pages.",
    "items":{
        "$ref":"#/components/schemas/cases-Attachments-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 : cases-Attachments-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 : 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 : cases-caseContacts-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the contact for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case contact 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 contact for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Contact",
            "type":"boolean",
            "description":"Indicates whether the contact is the primary contact for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "CaseContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the case contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "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 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.",
            "nullable":true,
            "x-queryable":false
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the case contact can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipCdMeaning":{
            "title":"Relationship Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the relationship lookup code for the case contact.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipCd"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the case contact can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of a person who is an employee on the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the contact for the case 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 contact for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipCd":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"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,",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : cases-caseHouseholds-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the household for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case household 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 household for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Household",
            "type":"boolean",
            "description":"Indicates whether the household is the primary household for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "HouseholdName":{
            "title":"Household Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the household.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "HouseholdPartyNumber":{
            "title":"Household Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the household party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseHouseholdId":{
            "title":"Household ID",
            "type":"integer",
            "description":"The unique identifier of the case household.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the household for the case 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 household for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : cases-caseMessages-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the message.",
            "nullable":false,
            "x-queryable":true
        },
        "VisibilityCd":{
            "title":"Visibility",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_SVC_INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageTypeCd":{
            "title":"Message Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the message, such as internal or external.",
            "nullable":false,
            "default":"ORA_SVC_NOTE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageLastUpdateDate":{
            "title":"Message Last Update Date",
            "type":"string",
            "description":"The date and time when the case message was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCd":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete an attachment.",
            "items":{
                "$ref":"#/components/schemas/cases-caseMessages-Attachments-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "MessageTypeCdMeaning":{
            "title":"Message Type Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the message type lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MessageTypeCd"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageLastUpdatedBy":{
            "title":"Message Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "LastEditedDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the case message was last edited.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceCdMeaning":{
            "title":"Source Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the source lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceCd"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the message for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostedByPartyId":{
            "title":"Posting Party ID",
            "type":"integer",
            "description":"The unique identifier of the user party who posted the message.",
            "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 for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the message. For example,  ORA_SVC_COMMITTED, indicates that the message is committed, or NULL.",
            "nullable":false,
            "default":"ORA_SVC_COMMITTED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentMessageId":{
            "title":"Parent Message",
            "type":"integer",
            "description":"The unique identifier of the parent message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PostedByPartyNumber":{
            "title":"Posting Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the user party who posted the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCreatedBy":{
            "title":"Message Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageLastUpdateLogin":{
            "title":"Message Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The application login id of the user who last updated the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationDate":{
            "title":"Origination Date",
            "type":"string",
            "description":"The date when the message originated, or was posted.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "MessageCreationDate":{
            "title":"Message Creation Date",
            "type":"string",
            "description":"The date and time when the case message was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"The content of the message that is not an attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PostedByPartyName":{
            "title":"Posted by Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party who posted the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RichTextFlag":{
            "title":"Rich Text Format",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the message content is in rich text format The values are Y or N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the message for the case 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 message for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object cases-caseMessages-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete an attachment.",
    "items":{
        "$ref":"#/components/schemas/cases-caseMessages-Attachments-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 : cases-caseMessages-Attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

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

Nested Schema : Attachment Previews

Type: array

Title: Attachment Previews

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

Show Source

• Array of: object cases-caseMessages-Attachments-AttachmentsPreview-item-response

{
    "title":"Attachment Previews",
    "type":"array",
    "description":"The attachments preview resource is used to preview the attachment pages.",
    "items":{
        "$ref":"#/components/schemas/cases-caseMessages-Attachments-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 : cases-caseMessages-Attachments-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 : cases-caseOpportunities-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyName":{
            "title":"Opportunity Name",
            "maxLength":"275",
            "type":"string",
            "description":"The opportunity name of the case opportunity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted by the current user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the case opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated by the current user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CaseOpportunityId":{
            "title":"Case Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the case.",
            "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"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the case opportunity.",
            "nullable":false,
            "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-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":false,
            "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 : cases-caseResources-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the resource for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case resource 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 resource for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the resource is the owner of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CaseResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the case resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the contact who created the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the user who created the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource for the case 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 session of the user who last updated the resource for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"The REST resources the Action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedIn":{
            "title":"Included In",
            "maxLength":"150",
            "type":"string",
            "description":"The View Object corresponding to the primary object the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextualFlag":{
            "title":"Contextual",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates  the contexual flag.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"The list of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionContextParameters":{
            "title":"Action Context Parameters",
            "maxLength":"1000",
            "type":"string",
            "description":"Determines the context when a smart action is applicable.",
            "nullable":true,
            "x-queryable":false
        },
        "UserActionNavigation":{
            "title":"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/cases-smartActions-UserActionNavigation-item-response"
            }
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The consumer friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the Action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"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/cases-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"The attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The Page Type.",
            "nullable":true,
            "x-queryable":true
        },
        "Condition":{
            "title":"Filter Condition",
            "maxLength":"1000",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the smart suggest flag.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Path Parameter Definitions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/cases-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the Action.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalFlag":{
            "title":"Restricted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action is internal type.",
            "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
        },
        "UserPrivilege":{
            "title":"User Security Privilege",
            "maxLength":"4000",
            "type":"string",
            "description":"The User Security Privilege.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The attribute uniquely identifies the action with name. For internal use.",
            "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
        },
        "DataPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":"250",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionSource":{
            "title":"Action Source",
            "maxLength":"512",
            "type":"string",
            "description":"Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationRoles":{
            "title":"Application Roles",
            "maxLength":"2000",
            "type":"string",
            "description":"The application roles associated with the smart action.",
            "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 : User Interface Definitions

Type: array

Title: 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 cases-smartActions-UserActionNavigation-item-response

{
    "title":"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/cases-smartActions-UserActionNavigation-item-response"
    }
}

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

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

{
    "title":"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/cases-smartActions-UserActionRequestPayload-item-response"
    }
}

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

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

{
    "title":"Path Parameter Definitions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/cases-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : cases-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 : cases-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 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.

{
    "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 smart suggest path.",
            "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 : cases-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: 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.

{
    "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":"80",
            "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":"50",
            "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"
    }
}

Links

Attachments

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments

Parameters:

• CaseNumber: $request.path.CaseNumber

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

BusinessUnitPVO

Operation: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits

The service business units resource is used to view the units of an enterprise that have been configured to function as customer support or as a human resource help desk.

CaseTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_TYPE_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

HouseholdVO

Operation: /crmRestApi/resources/11.13.18.05/households

An object that includes attributes used to store values while creating or updating a household. A household is a group that has a relationship with either an account or a contact.

PersonDVO

Operation: /crmRestApi/resources/11.13.18.05/contacts

An object that includes attributes used to store values while creating or updating a contact. A contact is a person who either has a relationship to other objects like contact and household or is a standalone customer or prospect. This object is an aggregation of person profile, contact information, and references a single primary address

PriorityCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_PRIORITY_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

QueueVO

Operation: /crmRestApi/resources/11.13.18.05/queues

Parameters:

• finder: QueueEnabledFinder

queue

ResourcePickerPVO

Operation: /crmRestApi/resources/11.13.18.05/resources

A front office person. For example, sales persons or partner members can be tagged as resources.

SensitivityCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_SENSITIVITY_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

SourceCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_SOURCE_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

SrCategoryVO

Operation: /crmRestApi/resources/11.13.18.05/categories

Parameters:

• finder: CategoryEnabledFinder

The categories resource is used to view, create, update, and delete service object categories. Categories enables grouping service objects to enable easy identification and downstream reporting. For example, service requests can be categorized based on the type of service requested, such as the need for general information or help with installation, or the area in which support is required, such as billing or order tracking. Similarly, knowledge articles can be categorized based on the article's subject area, such as installation or order status.

StatusCdLookup

Operation: /crmRestApi/resources/11.13.18.05/serviceRequestStatusesLOV

Parameters:

• finder: IsEnabledFinder%3BBindChildLookupType%3DORA_SVC_CASE_STATUS_CD%2CBindParentLookupType%3DORA_SVC_CASE_STATUS_TYPE_CD

The service request statuses resource is used to view a list of possible statuses that can be associated with a service request, such as New, In Progress, Resolved, and so on.

StatusTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_STATUS_TYPE_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

StripeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

assignQueue

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/action/assignQueue

Parameters:

• CaseNumber: $request.path.CaseNumber

Assign a case to a queue. You must ensure that assignment rules are configured for the case before assigning it to a queue. You can view the assignment rules using the task "Manage Service Assignment Task" . You must be a Case Manager to assign a case to a queue.

caseContacts

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts

Parameters:

• CaseNumber: $request.path.CaseNumber

The case contacts resource is used to view, create, update, and delete many-to-many relationships between cases and associated contacts.

caseHouseholds

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds

Parameters:

• CaseNumber: $request.path.CaseNumber

The case households resource is used to view, create, update, and delete many-to-many relationships between cases and associated households.

caseMessages

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages

Parameters:

• CaseNumber: $request.path.CaseNumber

The case messages resource is used to view, create, update, and delete information about every communication update associated with the case.

caseOpportunities

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities

Parameters:

• CaseNumber: $request.path.CaseNumber

The opportunities resources indicates the one-to-many relationships between the case and associated opportunities.

caseResources

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources

Parameters:

• CaseNumber: $request.path.CaseNumber

Case resources is used to view, create, update, and delete many-to-many relationships between cases and associated resources.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions

Parameters:

• CaseNumber: $request.path.CaseNumber

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.

Back to Top

Examples

The following example shows how to get a case 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/CDRM_4003

Example of Response Body

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

{
    "AssigneeResourceId": null,
    "BUOrgId": 204,
    "CaseCategoryId": null,
    "CaseCreatedBy": "AUTOUICASE1",
    "CaseCreationDate": "2021-08-23T06:29:02+00:00",
    "CaseId": 300100215793299,
    "CaseLastUpdateDate": "2021-08-23T06:29:02.001+00:00",
    "CaseLastUpdateLogin": "C9E512ADEE80EE12E05323EAF40AB50E",
    "CaseLastUpdatedBy": "AUTOUICASE1",
    "CaseNumber": "CDRM_4003",
    "ClosedDate": null,
    "CorpCurrencyCode": null,
    "CreatedBy": "AUTOUICASE1",
    "CreatedByPartyId": 300100112109025,
    "CreationDate": "2021-08-23T06:29:02+00:00",
    "CurcyConvRateType": null,
    "CurrencyCode": null,
    "Description": null,
    "LastClosedDate": null,
    "LastReopenDate": null,
    "LastUpdateDate": "2021-08-23T06:29:12.859+00:00",
    "LastUpdateLogin": "C9E4F38A864CEDEEE05323EAF40A0051",
    "LastUpdatedBy": "AUTOUICASE1",
    "LastUpdatedByPartyId": 300100112109025,
    "OpenDate": "2021-08-23T06:29:03.194+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_202170_232846974",
    "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_4003",
            "name": "cases",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
            "name": "cases",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/PersonDVO",
            "name": "PersonDVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/BusinessUnitPVO",
            "name": "BusinessUnitPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/SourceCdLookup",
            "name": "SourceCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/QueueVO",
            "name": "QueueVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/ResourcePickerPVO",
            "name": "ResourcePickerPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/SensitivityCdLookup",
            "name": "SensitivityCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/SrCategoryVO",
            "name": "SrCategoryVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/StatusCdLookup",
            "name": "StatusCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/HouseholdVO",
            "name": "HouseholdVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/StatusTypeCdLookup",
            "name": "StatusTypeCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/PriorityCdLookup",
            "name": "PriorityCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/lov/CaseTypeCdLookup",
            "name": "CaseTypeCdLookup",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/Attachments",
            "name": "Attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts",
            "name": "caseContacts",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseHouseholds",
            "name": "caseHouseholds",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages",
            "name": "caseMessages",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseOpportunities",
            "name": "caseOpportunities",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseResources",
            "name": "caseResources",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/smartActions",
            "name": "smartActions",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/action/assignQueue",
            "name": "assignQueue",
            "kind": "other"
        }
    ]
}

Back to Top