Get an inbound message part
get
/crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}
Request
Path Parameters
-
InboundMessageId(required): integer(int64)
The unique identifier of an inbound message.
-
InboundMsgPartId(required): integer(int64)
The unique identifier of the message part.
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : inboundMessages-InboundMsgParts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the inbound message part. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the inbound message part was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the inbound message part can be deleted. -
InboundMessageId: integer
(int64)
Title:
Inbound Message ID
The unique identifier of the inbound message with which the message part is associated. -
InboundMsgPartId: integer
(int64)
Title:
Inbound Message Part ID
The unique identifier of the message part. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the inbound message part was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the inbound message part. -
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. -
PartName: string
Title:
Part Name
Maximum Length:64
The header name of the inbound message part. -
PartTypeCd: string
Title:
Part Type Code
Maximum Length:30
The type of the inbound message part. -
PartTypeCdMeaning: string
Title:
Part Type Value
Maximum Length:255
The display value corresponding to the part type lookup code for the inbound message. -
PartValue: string
Title:
Part Value
Maximum Length:2000
The value of the inbound message part. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the inbound message part can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- PartTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_PART_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: PartTypeCd; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
Examples
The following example shows how to get an inbound message part by submitting a GET request on the REST resource.
Example of Request Header
The following shows an example of the request header.
GET /crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following example shows the contents of the response body.
"InboundMsgPartId": 300100091977703, "InboundMessageId": 300100091977695, "PartTypeCd": "ORA_SVC_TO", "PartName": "To", "PartValue": "incoming@server.fa.us2.oraclecloud.com", "CreationDate": "2017-04-02T19:54:21.004+00:00", "CreatedBy": "FUSION_APPS_CRM_ESS_APPID", "LastUpdateDate": "2017-04-02T19:54:21.014+00:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703", "name": "InboundMsgParts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703", "name": "InboundMsgParts", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695", "name": "inboundMessages", "kind": "item" } ] }