Post Collaboration Planners

Collaboration planners are Oracle Fusion application users assigned to a security context to access collaboration order forecast data.

You create a solution that allows your customer to use a client to connect to your partner application, and then use REST API to create new collaboration planners for order forecast collaboration.

Let's discuss this scenario:

  • Post a sample collection of collaboration planners.

Here's a typical application processing flow for the scenarios:

  1. You configure collaboration planners in Oracle Supply Chain Collaboration Cloud.
  2. You create a solution that allows your customer to use a client to connect to your partner application.

Post Collection of Collaboration Planners

To create collaboration planners:

  1. Run the POST operation against the URL to create collaboration planners:
  2. The response payload includes details that describe the results of the request.
  3. Your partner application extracts the values for these attributes from the response payload, and then displays them in the client.
    User Key Attribute Description
    Yes collaborationPlanners.UserName A unique identifier for the collaboration planner to authenticate with the service provider directly. This attribute is required.
      collaborationPlanners.FullAccessFlag Indicates whether the collaboration planner has access to all order forecast data.
      dataAccessSecurity.ShipFromSupplierId Value that uniquely identifies the supplier who ships the item. It is a primary key that the application generates when it creates the supplier.
    Yes dataAccessSecurity.ShipFromSupplierName Name of the supplier that ships the item.
      dataAccessSecurity.ShipFromSupplierSiteId Value that uniquely identifies the supplier site who ships the item. It is a primary key that the application creates when it creates the supplier site.
    Yes dataAccessSecurity.ShipFromSupplierSiteName Name of the supplier site that ships the item.
    Yes dataAccessSecurity.SecurityContext Value that identifies the level of security applied. Options are either supplier or supplier site.

Example URL

Use this resource URL format.

POST

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

Example Request

Here's an example of the request body in JSON format.

{
	"parts": [
	{
		"id" : "part1",
		"path" : "/collaborationPlanners",
		"operation" : "create",
		"payload" : {
			"UserName" : "MJohns2",
			"FullAccessFlag" : "True"
		}
	},
	{
		"id" : "part2",
		"path" : "/collaborationPlanners",
		"operation" : "create",
		"payload" : {
			"UserName" : "John.Smith",
			"FullAccessFlag" : "False",
			"dataAccessSecurity": [
			{
				"SecurityContext": "Supplier Site",
				"ShipFromSupplierName": "Tall Manufacturing",
				"ShipFromSupplierSiteName": "Atlanta"
			},
			{
				"SecurityContext": "Supplier Site",
				"ShipFromSupplierName": "Tall Manufacturing",
				"ShipFromSupplierSiteName": "Dallas"
			}
			]
		}
	}
	]
}

Example Response

Here's an example of the response body in JSON format.

{
	"parts":[
	{
		"id":"part1","path":"https://servername/fscmRestApi/resources/version/collaborationPlanners","operation":"create",
		"payload" : {
			"PersonId" : 100010032752379,
			"UserName" : "MJohns2",
			"FirstName" : "Mark",
			"LastName" : "Johnson",
			"DisplayName" : "Johnson,Mark",
			"Email" : "sendmail-test-discard@example.com",
			"Status" : "Active",
			"CreatedBy" : "ADMIN",
			"CreationDate" : "2018-04-19T16:25:01+00:00",
			"LastUpdatedBy" : "ADMIN",
			"LastUpdateDate" : "2018-04-19T16:25:01.081+00:00",
			"FullAccessFlag" : "true",
			"links" : [ {
				"rel" : "self",
				"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/100010032752379",
				"name" : "collaborationPlanners",
				"kind" : "item",
				"properties" : {
					"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				}
			}, {
				"rel" : "canonical",
				"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/100010032752379",
				"name" : "collaborationPlanners",
				"kind" : "item"
			}, {
				"rel" : "child",
				"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/100010032752379/child/dataAccessSecurity",
				"name" : "dataAccessSecurity",
				"kind" : "collection"
			} ]
		}
	}, 
	{
		"id" : "part2",
		"path" : "https://servername/fscmRestApi/resources/version/collaborationPlanners",
		"operation" : "create",
		"payload" : {
			"PersonId" : 300100032232206,
			"UserName" : "John.Smith",
			"FirstName" : "John",
			"LastName" : "Smith",
			"DisplayName" : "Smith, John",
			"Email" : "John.Smith@example.com",
			"Status" : "Active",
			"CreatedBy" : "ADMIN",
			"CreationDate" : "2018-04-19T16:25:01.027+00:00",
			"LastUpdatedBy" : "ADMIN",
			"LastUpdateDate" : "2018-04-19T16:25:01.082+00:00",
			"FullAccessFlag" : "false",
			"dataAccessSecurity" : [ {
				"DataAccessId" : 300100127557399,
				"SecurityContext" : "Supplier Site",
				"ShipFromSupplierId" : 12,
				"ShipFromSupplierName" : "Tall Manufacturing",
				"ShipFromSupplierSiteId" : 2444,
				"ShipFromSupplierSiteName" : "Atlanta",
				"ProcurementBUId" : 204,
				"ProcurementBUName" : "Vision Operations",
				"CreatedBy" : "ADMIN",
				"CreationDate" : "2018-04-19T16:25:01.075+00:00",
				"LastUpdatedBy" : "ADMIN",
				"LastUpdateDate" : "2018-04-19T16:25:01.112+00:00",
				"links" : [ {
					"rel" : "self",
					"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206/child/dataAccessSecurity/300100127557399",
					"name" : "dataAccessSecurity",
					"kind" : "item",
					"properties" : {
						"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
					}
				}, {
					"rel" : "canonical",
					"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206/child/dataAccessSecurity/300100127557399",
					"name" : "dataAccessSecurity",
					"kind" : "item"
				}, {
					"rel" : "parent",
					"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206",
					"name" : "collaborationPlanners",
					"kind" : "item"
				} ]
			}, {
				"DataAccessId" : 300100127557400,
				"SecurityContext" : "Supplier Site",
				"ShipFromSupplierId" : 12,
				"ShipFromSupplierName" : "Tall Manufacturing",
				"ShipFromSupplierSiteId" : 16,
				"ShipFromSupplierSiteName" : "Dallas",
				"ProcurementBUId" : 204,
				"ProcurementBUName" : "Vision Operations",
				"CreatedBy" : "ADMIN",
				"CreationDate" : "2018-04-19T16:25:01.077+00:00",
				"LastUpdatedBy" : "ADMIN",
				"LastUpdateDate" : "2018-04-19T16:25:01.125+00:00",
				"links" : [ {
					"rel" : "self",
					"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206/child/dataAccessSecurity/300100127557400",
					"name" : "dataAccessSecurity",
					"kind" : "item",
					"properties" : {
						"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
					}
				}, {
					"rel" : "canonical",
					"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206/child/dataAccessSecurity/300100127557400",
					"name" : "dataAccessSecurity",
					"kind" : "item"
				}, {
					"rel" : "parent",
					"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206",
					"name" : "collaborationPlanners",
					"kind" : "item"
				} ]
			} ],
			"links" : [ {
				"rel" : "self",
				"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206",
				"name" : "collaborationPlanners",
				"kind" : "item",
				"properties" : {
					"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				}
			}, {
				"rel" : "canonical",
				"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206",
				"name" : "collaborationPlanners",
				"kind" : "item"
			}, {
				"rel" : "child",
				"href" : "https://servername/fscmRestApi/resources/version/collaborationPlanners/300100032232206/child/dataAccessSecurity",
				"name" : "dataAccessSecurity",
				"kind" : "collection"
			} ]
		}
	} ]
}