REST API for Oracle Supply Chain Management Cloud

Create plans

post

/fscmRestApi/resources/11.13.18.05/collaborationPlans

Request

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.
Upsert-Mode:

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

application/json

Root Schema : schema

Type: object

Show Source

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.
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.
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.
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.
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.

{
    "type":"object",
    "properties":{
        "WeeklyFrequency":{
            "type":"integer",
            "description":"Number of weeks between new supply plans that the application publishes.",
            "nullable":true,
            "default":"1"
        },
        "StartDayOrdinalCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType"
                ]
            }
        },
        "Duration":{
            "title":"Frequency Duration",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "default":"1"
        },
        "StartDay":{
            "title":"Start Day",
            "type":"string",
            "description":"Day of the week that the application publishes supply plans for the publish cycle.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType",
                    "PublishCycleDayCode"
                ]
            }
        },
        "SupplyPlanSource":{
            "title":"Supply Plan Source",
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the source of the supply plan. Values include External or Oracle Supply Chain Planning Cloud.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the status. Value is A for active or I for inactive. The default value is A.",
            "nullable":false,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplyPlanSourceCode":{
            "title":"Supply Plan Source",
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that indicates the source of the supply plan. Values include ORA_VCS_EXT or ORA_VCS_SCP.",
            "nullable":false,
            "default":"ORA_VCS_SCP"
        },
        "StartDate":{
            "title":"Start Date",
            "type":"integer",
            "description":"Number that indicates the day of the month when the application publishes supply plans for the publish cycle. Values include 1 to 28.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3",
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType"
                ]
            }
        },
        "FrequencyCode":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"WEEKLY",
            "x-queryable":false
        },
        "StartTypeCode":{
            "title":"Monthly Start Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency"
                ]
            }
        },
        "PublishCycleDayCode":{
            "title":"Start Day",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType"
                ]
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the plan.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            }
        },
        "SupplyPlanId":{
            "title":"Supply Plan",
            "type":"integer",
            "description":"Value that uniquely identifies the supply plan published from Supply Chain Planning.",
            "nullable":true,
            "x-queryable":false
        },
        "Frequency":{
            "title":"Frequency",
            "type":"string",
            "description":"Value that indicates the frequency of the collaboration planning cycle. Values include Weekly and Monthly.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode"
                ]
            }
        },
        "StartType":{
            "title":"Monthly Start Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode"
                ]
            }
        },
        "CollaborationPlanName":{
            "title":"Collaboration Plan",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the collaboration plan.",
            "nullable":true
        },
        "CollaborationPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration plan that contains order forecast data shared with a supplier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StartDayOrdinal":{
            "title":"Start Day Ordinal",
            "type":"string",
            "description":"Ordinal values that indicate the position of the planning cycle's start day within a month. Values include First, Second, Third, Fourth, and Last.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType",
                    "StartDayOrdinalCode"
                ]
            }
        },
        "SupplyPlanName":{
            "title":"Supply Plan",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the supply plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Response

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-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the collaboration plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "WeeklyFrequency":{
            "type":"integer",
            "description":"Number of weeks between new supply plans that the application publishes.",
            "nullable":true,
            "default":"1",
            "x-queryable":true
        },
        "CollaborationFrequency":{
            "title":"Collaboration Frequency",
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PublishedBy":{
            "title":"Published By",
            "maxLength":"64",
            "type":"string",
            "description":"User who published the collaboration plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the status. Value is A for active or I for inactive. The default value is A.",
            "nullable":false,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastPublishedDate":{
            "title":"Last Published",
            "type":"string",
            "description":"Date when the user most recently published the collaboration plan.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyPlanSourceCode":{
            "title":"Supply Plan Source",
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that indicates the source of the supply plan. Values include ORA_VCS_EXT or ORA_VCS_SCP.",
            "nullable":false,
            "default":"ORA_VCS_SCP",
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"integer",
            "description":"Number that indicates the day of the month when the application publishes supply plans for the publish cycle. Values include 1 to 28.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3",
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType"
                ]
            },
            "x-queryable":true
        },
        "FrequencyCode":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"WEEKLY",
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the plan.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StartType":{
            "title":"Monthly Start Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode"
                ]
            },
            "x-queryable":true
        },
        "CollaborationPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration plan that contains order forecast data shared with a supplier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SupplyPlanName":{
            "title":"Supply Plan",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the supply plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the collaboration plan. Value is Active or Inactive. The default value is Active.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the collaboration plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the collaboration plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StartDayOrdinalCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType"
                ]
            },
            "x-queryable":true
        },
        "Duration":{
            "title":"Frequency Duration",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "default":"1",
            "x-queryable":true
        },
        "StartDay":{
            "title":"Start Day",
            "type":"string",
            "description":"Day of the week that the application publishes supply plans for the publish cycle.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType",
                    "PublishCycleDayCode"
                ]
            },
            "x-queryable":true
        },
        "SupplyPlanSource":{
            "title":"Supply Plan Source",
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the source of the supply plan. Values include External or Oracle Supply Chain Planning Cloud.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTypeCode":{
            "title":"Monthly Start Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency"
                ]
            },
            "x-queryable":true
        },
        "PublishCycleDayCode":{
            "title":"Start Day",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType"
                ]
            }
        },
        "SupplyPlanId":{
            "title":"Supply Plan",
            "type":"integer",
            "description":"Value that uniquely identifies the supply plan published from Supply Chain Planning.",
            "nullable":true,
            "x-queryable":false
        },
        "Frequency":{
            "title":"Frequency",
            "type":"string",
            "description":"Value that indicates the frequency of the collaboration planning cycle. Values include Weekly and Monthly.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode"
                ]
            },
            "x-queryable":true
        },
        "SourceSystemCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollaborationPlanName":{
            "title":"Collaboration Plan",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the collaboration plan.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDayOrdinal":{
            "title":"Start Day Ordinal",
            "type":"string",
            "description":"Ordinal values that indicate the position of the planning cycle's start day within a month. Values include First, Second, Third, Fourth, and Last.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FrequencyCode",
                    "Frequency",
                    "StartTypeCode",
                    "StartType",
                    "StartDayOrdinalCode"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the collaboration plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

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"
		}
		]
	}
	]
}