Update one message definition
patch
/fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions/{MessageId}
Request
Path Parameters
-
MessageId(required): integer(int64)
Value that uniquely identifies the collaboration message definition.
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
Root Schema : schema
Type:
Show Source
object
-
ApplicationPartnerCodeXpath: string
Maximum Length:
2000
Value that stores the sender application partner code cross reference path. -
b2bLocationAssignments: array
B2B Location Assignments
Title:
B2B Location Assignments
Details of the bill-to and ship-to location assignments configured for a message definition. -
DefaultEmailSubject: string
Maximum Length:
512
Subject of the message email, for example Purchase Order. -
emailProperties: array
Email Properties
Title:
Email Properties
An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email. -
GenericXsltFileName: string
Maximum Length:
512
Name of the XSLT file that contains the transformation to be applied, if any, for the message. -
MessageDescription: string
Maximum Length:
256
Description of the collaboration message definition. -
ObjectKeyXpath: string
Maximum Length:
2000
Value that identifies the XPath expression locating the object key in an XML payload. For example, the invoice number is the object key in the invoice XML file. -
PayloadTemplate: string
(byte)
Payload template associated with the message definition. A payload template is an XML sample that may be used for testing or validating your message setup.
-
RecipientEmailXpath: string
Maximum Length:
2000
Path that identifies the email recipient in the payload. -
XsltFile: string
(byte)
XSL file that's associated with the message definition. An XSL file is used for the transformation of the message.
Nested Schema : B2B Location Assignments
Type:
array
Title:
B2B Location Assignments
Details of the bill-to and ship-to location assignments configured for a message definition.
Show Source
Nested Schema : Email Properties
Type:
array
Title:
Email Properties
An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email.
Show Source
Nested Schema : b2bMessageDefinitions-b2bLocationAssignments-item-patch-request
Type:
Show Source
object
-
CrossReferenceB2BLocationAssignmentId: integer
(int64)
Value that uniquely identifies the cross reference domain assignments.
-
Type: string
Maximum Length:
100
Type of field. Valid values are SHIP_TO and BILL_TO. -
ValueXpath: string
Maximum Length:
2000
Value that identifies the XPath of the value to be evaluated.
Nested Schema : schema
Type:
Show Source
object
-
Name: string
Maximum Length:
512
Title or name of an attribute that is displayed as a column or header in the body of a B2B message email.
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.
Root Schema : b2bMessageDefinitions-item-response
Type:
Show Source
object
-
ApplicationPartnerCodeXpath: string
Maximum Length:
2000
Value that stores the sender application partner code cross reference path. -
AttachmentsFlag: boolean
Read Only:
true
Maximum Length:10
Contains one of the following values: true or false. If true, then the document supports attachments. If false, then the document doesn???t support attachments. The default value is false. -
b2bLocationAssignments: array
B2B Location Assignments
Title:
B2B Location Assignments
Details of the bill-to and ship-to location assignments configured for a message definition. -
DefaultEmailSubject: string
Maximum Length:
512
Subject of the message email, for example Purchase Order. -
Direction: string
Read Only:
true
Maximum Length:100
Value that indicates the direction of the message, either inbound or outbound. -
DirectionDescription: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description for the direction of the message. -
DocumentDescription: string
Read Only:
true
Maximum Length:256
Description of the transient collaboration document. -
DocumentId: integer
Value that uniquely identifies the collaboration document.
-
DocumentName: string
Maximum Length:
255
Name of the collaboration document associated with the message definition. -
DocumentType: string
Read Only:
true
Maximum Length:256
Value that uniquely identifies the type of document being sent, such as 'ProcessPurchaseOrder'. -
DocumentTypeDescription: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of document being sent, such as a Process Purchase Order. -
emailProperties: array
Email Properties
Title:
Email Properties
An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email. -
ExternalMessageTypeId: integer
(int64)
Value that uniquely identifies the external message definition associated with the collaboration message definition.
-
ExternalMessageTypeName: string
Name of the external message definition associated with the collaboration message definition.
-
GenericXsltFileName: string
Maximum Length:
512
Name of the XSLT file that contains the transformation to be applied, if any, for the message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDescription: string
Maximum Length:
256
Description of the collaboration message definition. -
MessageId: integer
(int64)
Value that uniquely identifies the collaboration message definition.
-
MessageName: string
Maximum Length:
256
Name of the collaboration message definition. -
MessageStandard: string
Read Only:
true
Maximum Length:100
Value that identifies the code of the messaging standard. -
MessageStandardDescription: string
Title:
Meaning
Read Only:true
Maximum Length:80
Value that describes the messaging standard; for example, OracleB2B. -
MessageSubtype: string
Read Only:
true
Maximum Length:512
A unique value used to identify a message when multiple messages share the same root element. -
MessageType: string
Read Only:
true
Maximum Length:100
The name of a unique XML schema definition for a document, representing the root element of the payload, such as Process Purchase Order. -
MessageVersion: string
Read Only:
true
Maximum Length:100
Version of the message standard, for example 10.1. -
ObjectKeyXpath: string
Maximum Length:
2000
Value that identifies the XPath expression locating the object key in an XML payload. For example, the invoice number is the object key in the invoice XML file. -
PayloadTemplate: string
(byte)
Payload template associated with the message definition. A payload template is an XML sample that may be used for testing or validating your message setup.
-
RecipientEmailXpath: string
Maximum Length:
2000
Path that identifies the email recipient in the payload. -
ServiceProviderName: string
Name of the service provider that the message definition was created for.
-
TrOrigionalMessageId: string
Value that uniquely identifies the original message from which attributes are used to create a new message definition.
-
UserDefinedFlag: boolean
Read Only:
true
Maximum Length:10
Value that indicates whether the message definition is predefined. Contains one of the following values: true or false. If true, it is a predefined message; if false, it is a user-created message -
XsltFile: string
(byte)
XSL file that's associated with the message definition. An XSL file is used for the transformation of the message.
Nested Schema : B2B Location Assignments
Type:
array
Title:
B2B Location Assignments
Details of the bill-to and ship-to location assignments configured for a message definition.
Show Source
Nested Schema : Email Properties
Type:
array
Title:
Email Properties
An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bMessageDefinitions-b2bLocationAssignments-item-response
Type:
Show Source
object
-
CrossReferenceB2BLocationAssignmentId: integer
(int64)
Value that uniquely identifies the cross reference domain assignments.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Type: string
Maximum Length:
100
Type of field. Valid values are SHIP_TO and BILL_TO. -
ValueXpath: string
Maximum Length:
2000
Value that identifies the XPath of the value to be evaluated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : b2bMessageDefinitions-emailProperties-item-response
Type:
Show Source
object
-
EmailPropertyId: integer
(int64)
Value that uniquely identifies the email properties.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
512
Title or name of an attribute that is displayed as a column or header in the body of a B2B message email. -
SequenceNumber: integer
(int32)
Autonumber starting with 1
-
TitleType: string
Maximum Length:
100
Type of title for which the name is specified, valid values are Header or Column.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- b2bLocationAssignments
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions/{MessageId}/child/b2bLocationAssignmentsParameters:
- MessageId:
$request.path.MessageId
Details of the bill-to and ship-to location assignments configured for a message definition. - MessageId:
- emailProperties
-
Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions/{MessageId}/child/emailPropertiesParameters:
- MessageId:
$request.path.MessageId
An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email. - MessageId: