Create plans

post

/fscmRestApi/resources/11.13.18.05/collaborationPlans

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
  • Value that uniquely identifies the collaboration plan that contains order forecast data shared with a supplier.
  • Title: Collaboration Plan
    Maximum Length: 30
    Name of the collaboration plan.
  • Title: Frequency Duration
    Default Value: 1
    Number of time intervals before a new plan is published. The time interval is based on the value of the Frequency attribute. For example, if Frequency is Monthly and Duration is 3, then the plan is published every three months.
  • Title: Frequency
    Value that indicates the frequency of the collaboration planning cycle. Values include Weekly and Monthly.
  • Title: Frequency
    Maximum Length: 30
    Default Value: WEEKLY
    Abbreviation that indicates the frequency of the collaboration planning cycle. Values include ORA_VCS_PLAN_CYCLE_FRQ_WEEKLY and ORA_VCS_PLAN_CYCLE_FRQ_MONTHLY.
  • Number that identifies the version of the plan.
  • Title: Start Day
    Maximum Length: 30
    Abbreviation that identifies the day that the publish cycle started. Contains one of the following values: ORA_VCS_WEEKDAY_SUNDAY, ORA_VCS_WEEKDAY_MONDAY, ORA_VCS_WEEKDAY_TUESDAY, ORA_VCS_WEEKDAY_WEDNESDAY, ORA_VCS_WEEKDAY_THURSDAY, ORA_VCS_WEEKDAY_FRIDAY, or ORA_VCS_WEEKDAY_SATURDAY.
  • Title: Start Date
    Number that indicates the day of the month when the application publishes supply plans for the publish cycle. Values include 1 to 28.
  • Title: Start Day
    Day of the week that the application publishes supply plans for the publish cycle.
  • Title: Start Day Ordinal
    Ordinal values that indicate the position of the planning cycle's start day within a month. Values include First, Second, Third, Fourth, and Last.
  • Maximum Length: 30
    Abbreviation of the ordinal values that indicate the position of the planning cycle's start day within a month. Values include ORA_VCS_ORD_POS_FIRST, ORA_VCS_ORD_POS_SECOND, ORA_VCS_ORD_POS_THIRD, ORA_VCS_ORD_POS_FOURTH, and ORA_VCS_ORD_POS_LAST.
  • Title: Monthly Start Type
    Value that indicates whether the planning cycle start is defined on a date or on a day of the month. Values include Start Date or Start Day.
  • Title: Monthly Start Type
    Maximum Length: 30
    Abbreviation that indicates whether the planning cycle start is defined on a date or on a day of the month. Values include ORA_VCS_START_DATE or ORA_VCS_START_DAY.
  • Title: Status
    Maximum Length: 32
    Default Value: A
    Abbreviation that identifies the status. Value is A for active or I for inactive. The default value is A.
  • Title: Supply Plan
    Value that uniquely identifies the supply plan published from Supply Chain Planning.
  • Title: Supply Plan
    Maximum Length: 30
    Name of the supply plan.
  • Title: Supply Plan Source
    Maximum Length: 255
    Value that indicates the source of the supply plan. Values include External or Oracle Supply Chain Planning Cloud.
  • Title: Supply Plan Source
    Maximum Length: 32
    Default Value: ORA_VCS_SCP
    Abbreviation that indicates the source of the supply plan. Values include ORA_VCS_EXT or ORA_VCS_SCP.
  • Default Value: 1
    Number of weeks between new supply plans that the application publishes.
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 : collaborationPlans-item-response
Type: object
Show Source
  • Title: Collaboration Frequency
    Read Only: true
    Maximum Length: 255
    Value that indicates the collaboration frequency of the collaboration planning cycle. It's derived based on the values specified by the plan's frequency, duration, start date, start day, or start day ordinal. For example, if the frequency is weekly, the duration is 1, and the start day is Monday, then the collaboration frequency would be every week on Monday.
  • Value that uniquely identifies the collaboration plan that contains order forecast data shared with a supplier.
  • Title: Collaboration Plan
    Maximum Length: 30
    Name of the collaboration plan.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the collaboration plan.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the collaboration plan.
  • Title: Frequency Duration
    Default Value: 1
    Number of time intervals before a new plan is published. The time interval is based on the value of the Frequency attribute. For example, if Frequency is Monthly and Duration is 3, then the plan is published every three months.
  • Title: Frequency
    Value that indicates the frequency of the collaboration planning cycle. Values include Weekly and Monthly.
  • Title: Frequency
    Maximum Length: 30
    Default Value: WEEKLY
    Abbreviation that indicates the frequency of the collaboration planning cycle. Values include ORA_VCS_PLAN_CYCLE_FRQ_WEEKLY and ORA_VCS_PLAN_CYCLE_FRQ_MONTHLY.
  • Title: Last Published
    Read Only: true
    Date when the user most recently published the collaboration plan.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the collaboration plan.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the collaboration plan.
  • Links
  • Number that identifies the version of the plan.
  • Title: Start Day
    Maximum Length: 30
    Abbreviation that identifies the day that the publish cycle started. Contains one of the following values: ORA_VCS_WEEKDAY_SUNDAY, ORA_VCS_WEEKDAY_MONDAY, ORA_VCS_WEEKDAY_TUESDAY, ORA_VCS_WEEKDAY_WEDNESDAY, ORA_VCS_WEEKDAY_THURSDAY, ORA_VCS_WEEKDAY_FRIDAY, or ORA_VCS_WEEKDAY_SATURDAY.
  • Title: Published By
    Read Only: true
    Maximum Length: 64
    User who published the collaboration plan.
  • Title: Source System
    Read Only: true
    Maximum Length: 80
    Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.
  • Title: Start Date
    Number that indicates the day of the month when the application publishes supply plans for the publish cycle. Values include 1 to 28.
  • Title: Start Day
    Day of the week that the application publishes supply plans for the publish cycle.
  • Title: Start Day Ordinal
    Ordinal values that indicate the position of the planning cycle's start day within a month. Values include First, Second, Third, Fourth, and Last.
  • Maximum Length: 30
    Abbreviation of the ordinal values that indicate the position of the planning cycle's start day within a month. Values include ORA_VCS_ORD_POS_FIRST, ORA_VCS_ORD_POS_SECOND, ORA_VCS_ORD_POS_THIRD, ORA_VCS_ORD_POS_FOURTH, and ORA_VCS_ORD_POS_LAST.
  • Title: Monthly Start Type
    Value that indicates whether the planning cycle start is defined on a date or on a day of the month. Values include Start Date or Start Day.
  • Title: Monthly Start Type
    Maximum Length: 30
    Abbreviation that indicates whether the planning cycle start is defined on a date or on a day of the month. Values include ORA_VCS_START_DATE or ORA_VCS_START_DAY.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the collaboration plan. Value is Active or Inactive. The default value is Active.
  • Title: Status
    Maximum Length: 32
    Default Value: A
    Abbreviation that identifies the status. Value is A for active or I for inactive. The default value is A.
  • Title: Supply Plan
    Value that uniquely identifies the supply plan published from Supply Chain Planning.
  • Title: Supply Plan
    Maximum Length: 30
    Name of the supply plan.
  • Title: Supply Plan Source
    Maximum Length: 255
    Value that indicates the source of the supply plan. Values include External or Oracle Supply Chain Planning Cloud.
  • Title: Supply Plan Source
    Maximum Length: 32
    Default Value: ORA_VCS_SCP
    Abbreviation that indicates the source of the supply plan. Values include ORA_VCS_EXT or ORA_VCS_SCP.
  • Default Value: 1
    Number of weeks between new supply plans that the application publishes.
Back to Top

Examples

This example describes how to create one collaboration plan.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example creates collaboration plan InactiveOATS-SCC-Plan-2:

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

Example 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": "/collaborationPlans",
		"operation": "create",
		"payload": {
			"SupplyPlanId": "300100087557648",
			"CollaborationPlanName": "Plan-1",
			"SupplyPlanSource": "Oracle Supply Chain Planning Cloud",
			"StatusCode": "A",
			"Frequency": "Weekly",
			"Duration": 1,
			"PublishCycleDayCode": "ORA_VCS_WEEKDAY_WEDNESDAY"
		}
	},
	{
		"id": "part2",
		"path": "/collaborationPlans",
		"operation": "create",
		"payload": {
			"SupplyPlanId": "300100087557664",
			"CollaborationPlanName": "Plan-2",
			"SupplyPlanSource": "Oracle Supply Chain Planning Cloud",
			"StatusCode": "A",
			"Frequency": "Monthly",
			"Duration": 1,
			"StartType": "Start day",
			"StartDayOrdinal": "Second",
			"StartDay": "Monday"
		}
	},
	{
		"id": "part3",
		"path": "/collaborationPlans",
		"operation": "create",
		"payload": {
			"SupplyPlanId": "300100087557678",
			"CollaborationPlanName": "Plan-3",
			"SupplyPlanSource": "Oracle Supply Chain Planning Cloud",
			"StatusCode": "A",
			"Frequency": "Monthly",
			"Duration": 1,
			"StartType": "Start day",
			"StartDate": 1
		}
	}
	]
}

Example Response Body

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

{
	"items": [
	{
		"SupplyPlanId": 300100087557648,
		"SupplyPlanName": "Sup-Plan-1",
		"CollaborationPlanName": "Plan-1",
		"CollaborationPlanId": 300100110989277,
		"SupplyPlanSourceCode": "ORA_VCS_SCP",
		"SupplyPlanSource": "Oracle Supply Chain Planning Cloud",
		"SourceSystemCode": "ORA_VCS_SRCSYSTEM_ORACLE",
		"SourceSystem": "Oracle",
		"StatusCode": "A",
		"Status": "Active",
		"FrequencyCode": "ORA_VCS_PLAN_CYCLE_FRQ_WEEKLY",
		"Frequency": "Weekly",
		"Duration": 1,
		"WeeklyFrequency": 1,
		"StartTypeCode": null,
		"StartType": null,
		"StartDayOrdinalCode": null,
		"StartDayOrdinal": null,
		"PublishCycleDayCode": "ORA_VCS_WEEKDAY_MONDAY",
		"StartDay": "Monday",
		"StartDate": null,
		"CreatedBy": "COLLABPLANNER",
		"CreationDate": "2017-06-02T16:54:47-07:00",
		"LastUpdatedBy": "COLLABPLANNER",
		"LastUpdateDate": "2017-06-03T01:30:17-07:00",
		"ObjectVersionNumber": 2,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/collaborationPlans/300100110989277",
			"name": "collaborationPlans",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/collaborationPlans/300100110989277",
			"name": "collaborationPlans",
			"kind": "item"
		}
		]
	},
	{
		"SupplyPlanId": 300100087557664,
		"SupplyPlanName": "Sup-Plan-2",
		"CollaborationPlanName": "Plan-2",
		"CollaborationPlanId": 300100114468504,
		"SupplyPlanSourceCode": "ORA_VCS_SCP",
		"SupplyPlanSource": "Oracle Supply Chain Planning Cloud",
		"SourceSystemCode": "ORA_VCS_SRCSYSTEM_ORACLE",
		"SourceSystem": "Oracle",
		"StatusCode": "A",
		"Status": "Active",
		"FrequencyCode": "ORA_VCS_PLAN_CYCLE_FRQ_MONTHLY",
		"Frequency": "Monthly",
		"Duration": 1,
		"WeeklyFrequency": 1,
		"StartTypeCode": "ORA_VCS_START_DAY",
		"StartType": "Start day",
		"StartDayOrdinalCode": "ORA_VCS_ORD_POS_SECOND",
		"StartDayOrdinal": "Second",
		"PublishCycleDayCode": "ORA_VCS_WEEKDAY_MONDAY",
		"StartDay": "Monday",
		"StartDate": null,
		"CreatedBy": "COLLABPLANNER",
		"CreationDate": "2017-06-15T13:22:56.638-07:00",
		"LastUpdatedBy": "COLLABPLANNER",
		"LastUpdateDate": "2017-06-16T05:47:54-07:00",
		"ObjectVersionNumber": 2,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/collaborationPlans/300100114468504",
			"name": "collaborationPlans",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/collaborationPlans/300100114468504",
			"name": "collaborationPlans",
			"kind": "item"
		}
		]
	},
	{
		"SupplyPlanId": 300100087557678,
		"SupplyPlanName": "Sup-Plan-3",
		"CollaborationPlanName": "Plan-3",
		"CollaborationPlanId": 308100114468874,
		"SupplyPlanSourceCode": "ORA_VCS_SCP",
		"SupplyPlanSource": "Oracle Supply Chain Planning Cloud",
		"SourceSystemCode": "ORA_VCS_SRCSYSTEM_ORACLE",
		"SourceSystem": "Oracle",
		"StatusCode": "A",
		"Status": "Active",
		"FrequencyCode": "ORA_VCS_PLAN_CYCLE_FRQ_MONTHLY",
		"Frequency": "Monthly",
		"Duration": 1,
		"WeeklyFrequency": 1,
		"StartTypeCode": "ORA_VCS_START_DATE",
		"StartType": "Start date",
		"StartDayOrdinalCode": null,
		"StartDayOrdinal": null,
		"PublishCycleDayCode": null,
		"StartDay": null,
		"StartDate": 1,
		"CreatedBy": "COLLABPLANNER",
		"CreationDate": "2017-06-15T13:22:56.638-07:00",
		"LastUpdatedBy": "COLLABPLANNER",
		"LastUpdateDate": "2017-06-16T05:47:54-07:00",
		"ObjectVersionNumber": 2,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/collaborationPlans/308100114468874",
			"name": "collaborationPlans",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/collaborationPlans/308100114468874",
			"name": "collaborationPlans",
			"kind": "item"
		}
		]
	}
	]
}
Back to Top