Create a trading partner item

post

/fscmRestApi/resources/11.13.18.05/tradingPartnerItems

Request

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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-post-request
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: 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.
  • 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: 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.
Nested Schema : AttachmentDFF
Type: array
Show Source
Nested Schema : tradingPartnerItems-Attachments-AttachmentDFF-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
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-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 create a trading partner item.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/tradingPartnerItems"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"TradingPartnerType":"SUPPLIER",
	"TradingPartnerName":"World of Business",
	"TradingPartnerItemNumber":"ABC"
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
	"TradingPartnerItemId": 300100194236343,
	"TradingPartnerItemNumber": "ABC",
	"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"
	}
	]
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to create a customer item and a competitor item in a single call.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.batch+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/11.13.18.05/"

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"parts": 
	[
	{
		"id": "part1",
		"path": "/tradingPartnerItems",
		"operation": "create",
		"payload": 
		{
			"TradingPartnerType":"CUSTOMER",
			"RegistryId":"1006",
			"TradingPartnerItemNumber":"XY_CU1"
		}    
	},    
	{
		"id": "part2",
		"path": "/tradingPartnerItems",
		"operation": "create",
		"payload": 
		{           
			"TradingPartnerType":"COMPETITOR",
			"RegistryId":"1000",
			"TradingPartnerItemNumber":"AB_CO1"
		}
	}
	]
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
	"parts": [
	{
		"id": "part1",
		"path": "https://servername/fscmRestApi/resources/version/tradingPartnerItems",
		"operation": "create",
		"payload": {
			"TradingPartnerItemId": 300100197102031,
			"TradingPartnerItemNumber": "XY_CU1",
			"TradingPartnerItemDescription": null,
			"TradingPartnerItemStatus": null,
			"TradingPartnerType": "CUSTOMER",
			"TradingPartnerId": 1000,
			"TradingPartnerName": "World of Business",
			"RegistryId": "1000",
			"StartDate": "2020-07-10",
			"EndDate": null,
			"CreationDateTime": "2020-07-10T09:57:36.001+00:00",
			"LastUpdateDateTime": "2020-07-10T09:57:36.110+00:00",
			"CreatedBy": "X",
			"LastUpdateLogin": "A9F34275918F13B3E0537AA8F00AE37D",
			"LastUpdatedBy": "X",
			"links": [
			{
				"rel": "self",
				"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100197102031",
				"name": "tradingPartnerItems",
				"kind": "item",
				"properties": {
					"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				}
			},
			{
				"rel": "canonical",
				"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100197102031",
				"name": "tradingPartnerItems",
				"kind": "item"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100197102031/child/Attachments",
				"name": "Attachments",
				"kind": "collection"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100197102031/child/DFF",
				"name": "DFF",
				"kind": "collection"
			}
			]
		}
	},
	{
		"id": "part2",
		"path": "https://servername/fscmRestApi/resources/version/tradingPartnerItems",
		"operation": "create",
		"payload": {
			"TradingPartnerItemId": 300100197102032,
			"TradingPartnerItemNumber": "AB_CO1",
			"TradingPartnerItemDescription": null,
			"TradingPartnerItemStatus": null,
			"TradingPartnerType": "COMPETITOR",
			"TradingPartnerId": 1004,
			"TradingPartnerName": "Hilman and Associates",
			"RegistryId": "1004",
			"StartDate": "2020-07-10",
			"EndDate": null,
			"CreationDateTime": "2020-07-10T09:57:36.057+00:00",
			"LastUpdateDateTime": "2020-07-10T09:57:36.110+00:00",
			"CreatedBy": "X",
			"LastUpdateLogin": "A9F34275918F13B3E0537AA8F00AE37D",
			"LastUpdatedBy": "X",
			"links": [
			{
				"rel": "self",
				"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100197102032",
				"name": "tradingPartnerItems",
				"kind": "item",
				"properties": {
					"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				}
			},
			{
				"rel": "canonical",
				"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100197102032",
				"name": "tradingPartnerItems",
				"kind": "item"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100197102032/child/Attachments",
				"name": "Attachments",
				"kind": "collection"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100197102032/child/DFF",
				"name": "DFF",
				"kind": "collection"
			}
			]
		}
	}
	]
}
Back to Top