Jump to

• Request
• Response
• Examples

Update an inbound message part

patch

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

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "InboundMessageId":{
            "title":"Inbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the inbound message with which the message part is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InboundMsgPartId":{
            "title":"Inbound Message Part ID",
            "type":"integer",
            "description":"The unique identifier of the message part.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The header name of the inbound message part.",
            "nullable":true
        },
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the inbound message part.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartTypeCdMeaning":{
            "title":"Part Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the part type lookup code for the inbound message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartTypeCd"
                ]
            }
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The value of the inbound message part.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : inboundMessages-InboundMsgParts-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inbound message part.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inbound message part was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the inbound message part can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InboundMessageId":{
            "title":"Inbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the inbound message with which the message part is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InboundMsgPartId":{
            "title":"Inbound Message Part ID",
            "type":"integer",
            "description":"The unique identifier of the message part.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inbound message part 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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inbound message part.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The header name of the inbound message part.",
            "nullable":true,
            "x-queryable":true
        },
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the inbound message part.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartTypeCdMeaning":{
            "title":"Part Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the part type lookup code for the inbound message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartTypeCd"
                ]
            },
            "x-queryable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The value of the inbound message part.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the inbound message part can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

PartTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Back to Top

Examples

The following example shows how to update an inbound message part by submitting a PATCH request on the REST resource.

Example of Request Header

The following shows an example of the request header.

PATCH /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 Request Body

The following shows an example of the request body.

{
"PartTypeCd": "ORA_SVC_HEADER",
"PartName": "Date"
}

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_HEADER",
  "PartName": "Date",
  "PartValue": "[e-mail]",
  "CreationDate": "2017-04-02T19:54:21.004+00:00",
  "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
  "LastUpdateDate": "2017-04-21T12:18:33+00:00",
  "LastUpdatedBy": "sales_admin",
  "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "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"
    }
  ]
}

Back to Top