Get all plans
get
/fscmRestApi/resources/11.13.18.05/collaborationPlans
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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 collaboration plans according to collaboration plan identifier.
Finder Variables- CollaborationPlanId; integer; Value that uniquely identifies the collaboration plan.
- PrimaryKey Find collaboration plans according to collaboration plan identifier.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CollaborationPlanName; string; Name of the collaboration plan.
- Duration; integer; 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.
- Frequency; string; Value that indicates the frequency of the collaboration planning cycle. Values include Weekly and Monthly.
- LastPublishedDate; string; Date when the user most recently published the collaboration plan.
- PublishedBy; string; User who published the collaboration plan.
- SourceSystem; string; 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.
- SourceSystemCode; string; 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.
- StartDate; integer; Number that indicates the day of the month when the application publishes supply plans for the publish cycle. Values include 1 to 28.
- StartDay; string; Day of the week that the application publishes supply plans for the publish cycle.
- StartDayOrdinal; string; Ordinal values that indicate the position of the planning cycle's start day within a month. Values include First, Second, Third, Fourth, and Last.
- StartDayOrdinalCode; string; 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.
- StartType; string; 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.
- StartTypeCode; string; 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.
- Status; string; Status of the collaboration plan. Value is Active or Inactive. The default value is Active.
- StatusCode; string; Abbreviation that identifies the status. Value is A for active or I for inactive. The default value is A.
- SupplyPlanName; string; Name of the supply plan.
- SupplyPlanSource; string; Value that indicates the source of the supply plan. Values include External or Oracle Supply Chain Planning Cloud.
- SupplyPlanSourceCode; string; Abbreviation that indicates the source of the supply plan. Values include ORA_VCS_EXT or ORA_VCS_SCP.
- WeeklyFrequency; integer; Number of weeks between new supply plans that the application publishes.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : collaborationPlans
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationPlans-item-response
Type:
Show Source
object
-
CollaborationFrequency: string
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. -
CollaborationPlanId: integer
(int64)
Value that uniquely identifies the collaboration plan that contains order forecast data shared with a supplier.
-
CollaborationPlanName: string
Title:
Collaboration Plan
Maximum Length:30
Name of the collaboration plan. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the collaboration plan. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the collaboration plan. -
Duration: integer
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. -
Frequency: string
Title:
Frequency
Value that indicates the frequency of the collaboration planning cycle. Values include Weekly and Monthly. -
FrequencyCode: string
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. -
LastPublishedDate: string
(date-time)
Title:
Last Published
Read Only:true
Date when the user most recently published the collaboration plan. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the collaboration plan. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the collaboration plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number that identifies the version of the plan.
-
PublishCycleDayCode: string
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. -
PublishedBy: string
Title:
Published By
Read Only:true
Maximum Length:64
User who published the collaboration plan. -
SourceSystem: string
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. -
SourceSystemCode: string
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. -
StartDate: integer
(int32)
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. -
StartDay: string
Title:
Start Day
Day of the week that the application publishes supply plans for the publish cycle. -
StartDayOrdinal: string
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. -
StartDayOrdinalCode: string
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. -
StartType: string
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. -
StartTypeCode: string
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. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
Status of the collaboration plan. Value is Active or Inactive. The default value is Active. -
StatusCode: string
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. -
SupplyPlanId: integer
Title:
Supply Plan
Value that uniquely identifies the supply plan published from Supply Chain Planning. -
SupplyPlanName: string
Title:
Supply Plan
Maximum Length:30
Name of the supply plan. -
SupplyPlanSource: string
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. -
SupplyPlanSourceCode: string
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. -
WeeklyFrequency: integer
Default Value:
1
Number of weeks between new supply plans that the application publishes.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get all collaboration plans.
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/collaborationPlans
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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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" } ] } ], "count": 3, "hasMore": true, "limit": 1, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationPlans", "name": "collaborationPlans", "kind": "collection" } ] }