1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Product Lifecycle Management
  4. Trading Partner Items

Get all trading partner items

get

/fscmRestApi/resources/11.13.18.05/tradingPartnerItems

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Find trading partner items according to the primary key criteria.
      Finder Variables
      • TradingPartnerItemId; integer; Value that uniquely identifies the trading partner item.
    • findActiveTradingPartnerItems Find trading partners according to the trading partner type and trading partner name.
      Finder Variables
      • EndDate; string; Date when the trading partner item becomes ineffective.
      • StartDate; string; Date when the trading partner item becomes effective.
      • TradingPartnerName; string; Name of the trading partner.
      • TradingPartnerType; string; Type of the trading partner.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; User who created the trading partner item.
    • CreationDateTime; string; Date when the user created the trading partner item.
    • EndDate; string; Date when the trading partner item becomes ineffective.
    • LastUpdateDateTime; string; Date when the user most recently updated the trading partner item.
    • LastUpdateLogin; string; Login that the user used when updating the trading partner item.
    • LastUpdatedBy; string; User who most recently updated the trading partner item.
    • RegistryId; string; Value that uniquely identifies the party.
    • StartDate; string; Date when the trading partner item becomes effective.
    • TradingPartnerId; integer; Value that uniquely identifies the trading partner.
    • TradingPartnerItemDescription; string; Description of the trading partner item.
    • TradingPartnerItemId; integer; Value that uniquely identifies the trading partner item.
    • TradingPartnerItemNumber; string; Number that identifies a trading partner item such as supplier item, customer item, competitor item, and manufacturer part number.
    • TradingPartnerItemStatus; string; Status of the trading partner item. A list of accepted values is defined in the lookup type ORA_ACA_MFR_PART_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.
    • TradingPartnerName; string; Name of the trading partner.
    • TradingPartnerType; string; Type of the trading partner.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : tradingPartnerItems
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : tradingPartnerItems-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments of the trading partner items.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : tradingPartnerItems-Attachments-item-response
Type: object
Show Source
  • AttachmentDFF
  • Title: Category
    Maximum Length: 30
    Name of the trading partner item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
  • Title: Shared
    Contains one of the following values: true or false. If true then the trading partner attachment is shared. If false, then it's not shared. The default value is false.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    User who created the trading partner item attachment.
  • Title: Creation Date
    Read Only: true
    Date when the user created the trading partner attachment.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Abbreviation that indicates the type of data of trading partner item attachment. Valid values include WEB_PAGE, TEXT, or FILE.
  • Title: Description
    Maximum Length: 255
    Description of the trading partner item attachment.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Path to the folder in which the trading partner item attachment file is uploaded.
  • Read Only: true
    URL of the trading partner item attachment.
  • Title: DownloadInfo
    JSON object represented as a string containing information used to programmatically retrieve a file attachment.
  • Title: Error Status Code
    Abbreviation that indicates the error, if any, for the attachment.
  • Title: Error Status Message
    Text of the error message, if any, for the attachment.
  • Title: File Name
    Maximum Length: 2048
    Name of the file attached to the trading partner item.
  • Title: File Url
    URL of the trading partner item attachment file.
  • Title: Last Update Date
    Read Only: true
    Date when the user most recently updated the trading partner item attachment.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    User who most recently updated the trading partner item attachment.
  • Read Only: true
    Maximum Length: 255
    Login that the user used when updating the attachment.
  • Links
  • Title: Title
    Title of the trading partner item attachment.
  • Title: Uploaded File Content Type
    Type of the file content of the trading partner item attachment.
  • Title: File Size
    Size of the attached file.
  • Title: Uploaded File Name
    Name of the uploaded file of the trading partner item attachment.
  • Title: Uploaded Text
    Content of the attached text file.
  • Title: Uri
    Maximum Length: 4000
    URI appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID for trading partner item attachment.
  • Title: Url
    Maximum Length: 4000
    URL of the trading partner item attachment.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    Display name of the trading partner item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
Nested Schema : AttachmentDFF
Type: array
Show Source
Nested Schema : tradingPartnerItems-Attachments-AttachmentDFF-item-response
Type: object
Show Source
Nested Schema : tradingPartnerItems-DFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all trading partner items.

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/tradingPartnerItems"

For example, the following command gets all trading partner items:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradingPartnerItems?q=TradingPartnerItemNumber='M123'"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"TradingPartnerItemId": 300100194236343,
		"TradingPartnerItemNumber": "M123",
		"TradingPartnerItemDescription": null,
		"TradingPartnerItemStatus": null,
		"TradingPartnerType": "SUPPLIER",
		"TradingPartnerId": 1000,
		"TradingPartnerName": "World of Business",
		"RegistryId": "1000",
		"StartDate": "2020-07-10",
		"EndDate": null,
		"CreationDateTime": "2020-07-10T09:34:03.001+00:00",
		"LastUpdateDateTime": "2020-07-10T09:34:03.695+00:00",
		"CreatedBy": "x",
		"LastUpdateLogin": "A9F34275918F13B3E0537AA8F00AE37D",
		"LastUpdatedBy": "x",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100194236343",
			"name": "tradingPartnerItems",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100194236343",
			"name": "tradingPartnerItems",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100194236343/child/Attachments",
			"name": "Attachments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100194236343/child/DFF",
			"name": "DFF",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems",
		"name": "tradingPartnerItems",
		"kind": "collection"
	}
	]
}
Back to Top