Jump to

• Request
• Response
• Examples

Update an outbound message part

patch

/crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts/{OutboundMsgPartId}

Request

Path Parameters

• OutboundMessageId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• OutboundMsgPartId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurcyConvRateType: string
  Title: Type of Currency Conversion Rate

  Maximum Length: 30

  The currency conversion rate type for the message part. 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 message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• OutboundMessageId: integer (int64)
  Title: Outbound Message ID

  The unique identifier of the outbound message detail.
• OutboundMsgPartId: integer (int64)
  Title: Outbound Message Part ID

  The unique part identifier of the outbound message detail.
• PartName: string
  Title: Part Name

  Maximum Length: 64

  The part name of the outbound message detail.
• PartTypeCd: string
  Title: Part Type Code

  Maximum Length: 30

  The part type of the outbound message details.
• PartValue: string
  Title: Part Value

  Maximum Length: 2000

  The part value of the outbound message details.

{
    "type":"object",
    "properties":{
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The part type of the outbound message details.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "OutboundMsgPartId":{
            "title":"Outbound Message Part ID",
            "type":"integer",
            "description":"The unique part identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":"64",
            "type":"string",
            "description":"The part name of the outbound message detail.",
            "nullable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":"2000",
            "type":"string",
            "description":"The part value of the outbound message details.",
            "nullable":true
        },
        "OutboundMessageId":{
            "title":"Outbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurcyConvRateType":{
            "title":"Type of Currency Conversion Rate",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for the message part. 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
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        }
    }
}

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 : outboundMessages-OutboundMsgParts-item-response

Type: object

Show Source

• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the outbound message recipient.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the outbound message was created.
• CurcyConvRateType: string
  Title: Type of Currency Conversion Rate

  Maximum Length: 30

  The currency conversion rate type for the message part. 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 message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• DeleteFlag: boolean
  Title: Can Delete Message Part

  Read Only: true

  Indicates whether the outbound message is deleted.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the outbound message detail was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The login of the user who last updated the outbound message detail.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the outbound message detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OutboundMessageId: integer (int64)
  Title: Outbound Message ID

  The unique identifier of the outbound message detail.
• OutboundMsgPartId: integer (int64)
  Title: Outbound Message Part ID

  The unique part identifier of the outbound message detail.
• PartName: string
  Title: Part Name

  Maximum Length: 64

  The part name of the outbound message detail.
• PartTypeCd: string
  Title: Part Type Code

  Maximum Length: 30

  The part type of the outbound message details.
• PartValue: string
  Title: Part Value

  Maximum Length: 2000

  The part value of the outbound message details.
• UpdateFlag: boolean
  Title: Can Update Message Part

  Read Only: true

  Indicates whether the outbound message can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The login of the user who last updated the outbound message detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The part type of the outbound message details.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the outbound message 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 outbound message recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":"2000",
            "type":"string",
            "description":"The part value of the outbound message details.",
            "nullable":true,
            "x-queryable":true
        },
        "OutboundMessageId":{
            "title":"Outbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Type of Currency Conversion Rate",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for the message part. 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":true
        },
        "DeleteFlag":{
            "title":"Can Delete Message Part",
            "type":"boolean",
            "description":"Indicates whether the outbound message is deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update Message Part",
            "type":"boolean",
            "description":"Indicates whether the outbound message can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OutboundMsgPartId":{
            "title":"Outbound Message Part ID",
            "type":"integer",
            "description":"The unique part identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":"64",
            "type":"string",
            "description":"The part name of the outbound message detail.",
            "nullable":true,
            "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 associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the outbound message detail 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 outbound message detail.",
            "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 : 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_OBM_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 outbound message part by submitting a PATCH request on the REST resource using cURL.

cURL Command

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100188082127/child/OutboundMsgParts/300100188085657

Example of Request Body

The following shows the contents of the request body in JSON format.

{
      "PartValue": "[e-mail]"
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
  "OutboundMsgPartId": 300100188085657,
  "OutboundMessageId": 300100188082127,
  "PartTypeCd": "ORA_SVC_TO",
  "PartName": "To",
  "PartValue": "[e-mail]",
  "CreationDate": "2020-08-06T17:24:03+00:00",
  "CreatedBy": "FUSION",
  "LastUpdateDate": "2020-08-06T17:24:03.002+00:00",
  "LastUpdatedBy": "FUSION",
  "LastUpdateLogin": "AB8E5BAC48AD7278E0531C5CF00A3B51",
  "DeleteFlag": true,
  "UpdateFlag": true,
  "CorpCurrencyCode": null,
  "CurcyConvRateType": null,
  "CurrencyCode": null,
 ...
}

Back to Top