Get one inbound collaboration message
get
/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/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.
-
TradingPartnerId(required): integer(int64)
Value that uniquely identifies the trading partner. It is a primary key that the application generates when it creates a trading partner record. This attribute is required.
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 : b2bTradingPartners-inboundCollaborationMessages-item-response
Type:
Show Source
object
-
AcknowledgementCode: string
Maximum Length:
100
Default Value:Never
Value that indicates whether the application processing feedback should be 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 trading partner.
-
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 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 trading partner.
-
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.
-
messageProcessingRules: array
Message Processing Rules
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a 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 specifies 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)
Value 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 inbound and outbound that is sent through SOAP headers. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that indicates the duration of retention of the inbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that indicates the type of duration of retention 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 : Message Processing Rules
Type:
array
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-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 trading partner's predefined message definition. -
DvmName: string
Read Only:
true
Maximum Length:256
Name of the domain value map defined in the SOA composer. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the domain value map associated with the trading partner'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.
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the processing rule for the trading partner's collaboration message. -
DefaultValue: string
Maximum Length:
512
Value that specifies the default value of the node identified in the XPath. -
IncludeInOutputFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the processing rule for the trading partner's collaboration message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageNodeXpath: string
Maximum Length:
2000
Value that specifies the cross reference path of the external message. -
Name: string
Maximum Length:
512
Name of the message processing rule. -
NodeId: integer
(int64)
Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
-
ValueRequiredFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- domainValueMaps
-
Parameters:
- PartnerMessageId:
$request.path.PartnerMessageId
- TradingPartnerId:
$request.path.TradingPartnerId
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. - PartnerMessageId:
- messageProcessingRules
-
Parameters:
- PartnerMessageId:
$request.path.PartnerMessageId
- TradingPartnerId:
$request.path.TradingPartnerId
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message. - PartnerMessageId:
Examples
This example describes how to get one inbound collaboration message.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/b2bTradingPartners/TradingPartnerId/child/inboundCollaborationMessages/PartnerMessageId"
For example, the following command gets one inbound collaboration message:
curl -u username:password "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023"
Example Response Body
The following shows an example of the response body in JSON format.
{ "PartnerMessageId" : 300100073313023, "PartnerMessageName" : "Namein10_1_1", "PartnerMessageStatus" : "Entered", "PartnerMessageStatusDate" : "2015-12-03T12:02:04.987+00:00", "AcknowledgementCode" : "Never", "ProcessingAction" : "AcknowledgeReceiptAdvice", "ApplicationPartnerCodeXpath" : "AcknowledgeReceiveDelivery/DataArea/ReceiveDelivery/ReceiveDeliveryItem/Party/Location/ID", "ObjectKey1Xpath" : null, "ObjectKey2Xpath" : null, "ObjectKey3Xpath" : null, "ObjectKey4Xpath" : null, "ObjectKey5Xpath" : null, "ObjectKey6Xpath" : null, "MessageId" : 40033, "MessageName" : "OAGIS_10.1_ACK_RCV_DEL_COLLAB_MSG_IN", "DocumentId" : 40022, "PartnerMessageCustomizationId" : 300100073313023, "RetentionDuration" : null, "RetentionDurationType" : null, "OverrideStatus" : "Active", "OverrideStatusDate" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023", "name" : "inboundCollaborationMessages", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000274001353434D5F494D504C5F434F4E53554C54414E5478" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023", "name" : "inboundCollaborationMessages", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017", "name" : "b2bTradingPartners", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/lov/retentionDurationTypesLOV", "name" : "retentionDurationTypesLOV", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/lov/messagesLOV", "name" : "messagesLOV", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/lov/overrideStatusLOV", "name" : "overrideStatusLOV", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/child/messageProcessingRules", "name" : "messageProcessingRules", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/child/domainValueMaps", "name" : "domainValueMaps", "kind" : "collection" } ] }