PATCH action not supported
patch
/fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/inboundCollaborationMessages/{PartnerMessageId}
Request
Path Parameters
-
PartnerMessageId(required): integer(int64)
Value that uniquely identifies the trading partner message. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required.
-
ServiceProviderId(required): integer(int64)
Value that uniquely identifies the service provider. It is a primary key that the application generates when it creates a service provider record. This attribute is required.
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
Root Schema : schema
Type:
Show Source
object
-
AcknowledgementCode: string
Maximum Length:
100
Default Value:Never
Value that indicates whether the application processing feedback is sent for inbound messages or not. -
ApplicationPartnerCodeXpath: string
Maximum Length:
2000
Value that stores the application partner code cross reference path. -
domainValueMaps: array
Domain Value Maps
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. -
LastUpdateDate: string
(date-time)
Date when the user most recently updated the inbound collaboration message for the service provider.
-
MessageId: integer
(int64)
Title:
Collaboration Message Definition
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Name of the collaboration message.
-
ObjectKey1Xpath: string
Maximum Length:
2000
Value that identifies the first key of the XPath in the input payload. -
ObjectKey2Xpath: string
Maximum Length:
2000
Value that identifies the second key of the XPath in the input payload. -
ObjectKey3Xpath: string
Maximum Length:
2000
Value that identifies the third key of the XPath in the input payload. -
ObjectKey4Xpath: string
Maximum Length:
2000
Value that identifies the fourth key of the XPath in the input payload. -
ObjectKey5Xpath: string
Maximum Length:
2000
Value that identifies the fifth key of the XPath in the input payload. -
ObjectKey6Xpath: string
Maximum Length:
2000
Value that identifies the sixth key of the XPath in the input payload. -
OverrideStatus: string
Maximum Length:
100
Value that indicates the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
OverrideStatusDate: string
(date-time)
Date when the inbound collaboration message was overridden.
-
PartnerMessageStatus: string
Maximum Length:
100
Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
PartnerMessageStatusDate: string
(date-time)
Date when the inbound collaboration message was created or updated.
-
ProcessingAction: string
Maximum Length:
256
Value that defines the action of the inbound message. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that indicates the retention duration of the inbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that indicates the retention duration type of the inbound collaboration message.
Nested Schema : Domain Value Maps
Type:
array
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request
Type:
Show Source
object
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 : b2bServiceProviders-inboundCollaborationMessages-item-response
Type:
Show Source
object
-
AcknowledgementCode: string
Maximum Length:
100
Default Value:Never
Value that indicates whether the application processing feedback is sent for inbound messages or not. -
ApplicationPartnerCodeXpath: string
Maximum Length:
2000
Value that stores the application partner code cross reference path. -
CreationDate: string
(date-time)
Date when the user set up the inbound collaboration message for the service provider.
-
DocumentId: integer
(int64)
Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
-
DocumentName: string
Read Only:
true
Maximum Length:256
Name of the document associated with the inbound collaboration message. -
domainValueMaps: array
Domain Value Maps
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. -
LastUpdateDate: string
(date-time)
Date when the user most recently updated the inbound collaboration message for the service provider.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageId: integer
(int64)
Title:
Collaboration Message Definition
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Name of the collaboration message.
-
ObjectKey1Xpath: string
Maximum Length:
2000
Value that identifies the first key of the XPath in the input payload. -
ObjectKey2Xpath: string
Maximum Length:
2000
Value that identifies the second key of the XPath in the input payload. -
ObjectKey3Xpath: string
Maximum Length:
2000
Value that identifies the third key of the XPath in the input payload. -
ObjectKey4Xpath: string
Maximum Length:
2000
Value that identifies the fourth key of the XPath in the input payload. -
ObjectKey5Xpath: string
Maximum Length:
2000
Value that identifies the fifth key of the XPath in the input payload. -
ObjectKey6Xpath: string
Maximum Length:
2000
Value that identifies the sixth key of the XPath in the input payload. -
OverrideStatus: string
Maximum Length:
100
Value that indicates the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
OverrideStatusDate: string
(date-time)
Date when the inbound collaboration message was overridden.
-
PartnerMessageCustomizationId: integer
(int64)
Values that uniquely identifies the partner message customization. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required. This is a read-only attribute.
-
PartnerMessageId: integer
(int64)
Value that uniquely identifies the trading partner message. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required.
-
PartnerMessageName: string
Title:
Name
Maximum Length:256
Name of the inbound collaboration message. -
PartnerMessageStatus: string
Maximum Length:
100
Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
PartnerMessageStatusDate: string
(date-time)
Date when the inbound collaboration message was created or updated.
-
ProcessingAction: string
Maximum Length:
256
Value that defines the action of the inbound message. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that indicates the retention duration of the inbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that indicates the retention duration type of the inbound collaboration message. -
UserDefinedFlag: boolean
Read Only:
true
Value that indicates whether the inbound collaboration message is user defined. This value is not editable.
Nested Schema : Domain Value Maps
Type:
array
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the domain value map associated with the service provider's predefined message definition. -
DvmName: string
Read Only:
true
Maximum Length:256
Name of the domain value map. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the domain value map associated with the service provider's predefined message definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDvmId: integer
(int64)
Read Only:
true
Value that uniquely identifies the domain value map. It is a primary key that the application generates when it creates a domain value map record. This attribute is required. -
MessageId: integer
(int64)
Read Only:
true
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Read Only:
true
Name of the collaboration message.
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
- domainValueMaps
-
Parameters:
- PartnerMessageId:
$request.path.PartnerMessageId
- ServiceProviderId:
$request.path.ServiceProviderId
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. - PartnerMessageId: