Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ObjectKey4Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the fourth key of the XPath in the input payload.",
            "nullable":true
        },
        "domainValueMaps":{
            "title":"Domain Value Maps",
            "type":"array",
            "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request"
            }
        },
        "AcknowledgementCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates whether the application processing feedback is sent for inbound messages or not.",
            "nullable":true,
            "default":"Never"
        },
        "ObjectKey1Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the first key of the XPath in the input payload.",
            "nullable":true
        },
        "PartnerMessageStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":true
        },
        "OverrideStatusDate":{
            "type":"string",
            "description":"Date when the inbound collaboration message was overridden.",
            "format":"date-time",
            "nullable":true
        },
        "ObjectKey2Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the second key of the XPath in the input payload.",
            "nullable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "description":"Value that indicates the retention duration of the inbound collaboration message.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            }
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":false
        },
        "ProcessingAction":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that defines the action of the inbound message.",
            "nullable":true
        },
        "ObjectKey6Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the sixth key of the XPath in the input payload.",
            "nullable":true
        },
        "ApplicationPartnerCodeXpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that stores the application partner code cross reference path.",
            "nullable":true
        },
        "ObjectKey5Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the fifth key of the XPath in the input payload.",
            "nullable":true
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the retention duration type of the inbound collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "description":"Date when the inbound collaboration message was created or updated.",
            "format":"date-time",
            "nullable":true
        },
        "ObjectKey3Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the third key of the XPath in the input payload.",
            "nullable":true
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the inbound collaboration message for the service provider.",
            "format":"date-time",
            "nullable":false
        }
    }
}

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

• Array of: object b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request

{
    "title":"Domain Value Maps",
    "type":"array",
    "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request"
    }
}

Nested Schema : b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : b2bServiceProviders-inboundCollaborationMessages-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user set up the inbound collaboration message for the service provider.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerMessageCustomizationId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerMessageId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerMessageStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideStatusDate":{
            "type":"string",
            "description":"Date when the inbound collaboration message was overridden.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey2Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the second key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectKey6Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the sixth key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the retention duration type of the inbound collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name of the document associated with the inbound collaboration message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectKey3Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the third key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerMessageName":{
            "title":"Name",
            "maxLength":"256",
            "type":"string",
            "description":"Name of the inbound collaboration message.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectKey4Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the fourth key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "type":"boolean",
            "description":"Value that indicates whether the inbound collaboration message is user defined. This value is not editable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "domainValueMaps":{
            "title":"Domain Value Maps",
            "type":"array",
            "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response"
            }
        },
        "AcknowledgementCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates whether the application processing feedback is sent for inbound messages or not.",
            "nullable":true,
            "default":"Never",
            "x-queryable":true
        },
        "ObjectKey1Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the first key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "description":"Value that indicates the retention duration of the inbound collaboration message.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ProcessingAction":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that defines the action of the inbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationPartnerCodeXpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that stores the application partner code cross reference path.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey5Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the fifth key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "description":"Date when the inbound collaboration message was created or updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the inbound collaboration message for the service provider.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response

{
    "title":"Domain Value Maps",
    "type":"array",
    "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response"
    }
}

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 : b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user set up the domain value map associated with the service provider's predefined message definition.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDvmId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DvmName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name of the domain value map.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the domain value map associated with the service provider's predefined message definition.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

domainValueMaps

Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/inboundCollaborationMessages/{PartnerMessageId}/child/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.

Back to Top