Jump to

• Request
• Response
• Examples

Get one order forecast

get

/fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts/{CollaborationOrderForecastId}

Request

Path Parameters

• CollaborationOrderForecastId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : collaborationOrderForecasts-item-response

Type: object

Show Source

• B2BOnlyFlag: boolean
  Contains one of the following values: true or false. If true, then the collaboration order forecast was published to the supplier using only B2B messaging. If false, then B2B messaging wasn't the only method to publish the collaboration order forecast. This attribute doesn't have a default value.
• CollaborationCycleVersion: integer (int32)
  Read Only: true

  Version of the collaboration planning cycle.
• CollaborationOrderForecastId: integer (int64)
  Value that uniquely identifies the collaboration order forecast.
• CollaborationPlanId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration plan scenario.
• CollaborationPlanName: string
  Title: Name

  Read Only: true

  Maximum Length: 30

  Name of the collaboration plan.
• CollaborationSourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration plan.
• CommitDate: string (date-time)
  Read Only: true

  Date when the supply was committed against the collaboration order forecast.
• CommitDueDate: string (date-time)
  Read Only: true

  Date when the supply commits are due for the collaboration order forecast.
• commitQuantities: array Commit Quantities
  Title: Commit Quantities

  The Commit Quantities resource gets the current commit measure details associated with the collaboration order forecast. This resource can also be used to respond to collaboration order forecasts by providing supply commits.
• CommitTotalQuantity: number
  Read Only: true

  Sum of the commit quantities over the commit horizon for a collaboration order forecast.
• CorrelationCode: string
  Read Only: true

  Maximum Length: 64

  Abbreviation that identifies the orchestration process instance.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the collaboration order forecast.
• CreatedByPersonId: integer (int64)
  Read Only: true

  Value that uniquely identifies the person that created the collaboration order forecast.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the collaboration order forecast.
• DropShipFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then the collaboration order forecast data is for a drop ship relationship. If false, then the collaboration order forecast data isn't for a drop ship relationship. This attribute doesn't have a default value.
• exceptionQuantities: array Exception Quantities
  Title: Exception Quantities

  The Exception Quantities resource gets the forecast and commit exceptions associated with the collaboration order forecast, such as, forecast changes and commit mismatches.
• forecastQuantities: array Forecast Quantities
  Title: Forecast Quantities

  The Forecast Quantities resource gets the current forecast measure details associated with the collaboration order forecast. This resource can also be used to update or create new forecast quantities for collaboration order forecasts.
• ForecastTotalCommitHorizonQuantity: number
  Read Only: true

  Sum of the forecast quantities over the commit horizon for a collaboration order forecast.
• ForecastTotalForecastHorizonQuantity: number
  Read Only: true

  Sum of the forecast quantities over the forecast horizon for a collaboration order forecast.
• InventoryItemId: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the inventory item in the relationship candidate.
• ItemCategory: string
  Maximum Length: 255

  Category that the application assigns to the item from the default planning catalog.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the collaboration order forecast.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Login of the user who most recently updated the collaboration order forecast.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerName: string
  Read Only: true

  Maximum Length: 100

  Name of the manufacturer.
• ManufacturerPartNumber: string
  Read Only: true

  Maximum Length: 100

  Number that identifies the item at the manufacturer.
• NoteToPlanner: string
  Maximum Length: 1000

  Note provided by the supplier to the collaboration planner.
• NoteToSupplier: string
  Maximum Length: 1000

  Note provided by the collaboration planner to the supplier.
• OnHandPublishedByUserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 100

  User who most recently published the on-hand quantity.
• OnHandPublishedDate: string (date-time)
  Read Only: true

  Date when the on-hand quantity was published.
• OnHandQuantity: number
  Read Only: true

  Quantity of the on-hand inventory for the collaboration order forecast item.
• PlanningCycleEndDate: string (date)
  Read Only: true

  Date when the collaboration planning cycle ends.
• PlanningCycleStartDate: string (date)
  Read Only: true

  Date when the collaboration planning cycle begins.
• ProcurementBUId: integer (int64)
  Title: Business Unit ID

  Read Only: true

  Value that uniquely identifies the business unit.
• ProcurementBUName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of the business unit. The application assigns the supplier to this business unit.
• PublishedByPersonId: integer (int64)
  Read Only: true

  Value that uniquely identifies the most recent user to publish the collaboration order forecast.
• PublishedByUserName: string
  Read Only: true

  Maximum Length: 255

  User who most recently published the collaboration order forecast.
• PublishedDate: string (date-time)
  Read Only: true

  Date when the collaboration order forecast was published.
• referenceQuantities: array Reference Quantities
  Title: Reference Quantities

  The Reference Quantities resource gets the additional measures associated with the collaboration order forecast, such as, purchasing measures.
• ShipFromSupplierAlternateName: string
  Read Only: true

  Alternate name of the supplier that ships the item.
• ShipFromSupplierDUNS: string
  Read Only: true

  Maximum Length: 30

  Data universal numbering system of the supplier who ships the item.
• ShipFromSupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
• ShipFromSupplierName: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier that ships the item.
• ShipFromSupplierNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the supplier that ships the item.
• ShipFromSupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site in the relationship. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.
• ShipFromSupplierSiteName: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier site that ships the item.
• ShipToCustomerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer who will receive the item. It's a primary key that the application creates when it creates the customer.
• ShipToCustomerName: string
  Read Only: true

  Maximum Length: 255

  Name of the customer that receives the item.
• ShipToCustomerSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer site who will receive the item. It's a primary key that the application creates when it creates the customer site.
• ShipToCustomerSiteName: string
  Read Only: true

  Maximum Length: 255

  Name of the customer site that received the item.
• ShipToOrganizationCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the organization that receives the item.
• ShipToOrganizationId: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the organization in the collaboration order forecast. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
• ShipToOrganizationName: string
  Read Only: true

  Maximum Length: 255

  Name of the organization that receives the item.
• ShipToSupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier who receives the item. It's a primary key that the application generates when it creates the supplier.
• ShipToSupplierName: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier that receives the item.
• ShipToSupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site in the collaboration order forecast. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.
• ShipToSupplierSiteName: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier site in the collaboration order forecast that receives the item.
• SourceSystem: string
  Title: Meaning

  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
  Title: Lookup Code

  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.
• Status: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that indicates the current state of the collaboration order forecast. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• StatusCode: string
  Read Only: true

  Maximum Length: 32

  Abbreviation that identifies the current state of the collaboration order forecast. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• SupplierItemNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the item referred to by the supplier.
• SupplierOnHandPublishedByUserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 100

  User who most recently published the supplier on-hand quantity.
• SupplierOnHandPublishedDate: string (date-time)
  Read Only: true

  Date when the supplier on-hand quantity was published.
• SupplierOnHandQuantity: number
  Read Only: true

  Quantity of the supplier's on-hand inventory for the collaboration order forecast item.
• SupplyPlanDescription: string
  Read Only: true

  Maximum Length: 100

  Description of the supply plan that was used to generate the collaboration order forecast.
• SupplyPlanName: string
  Read Only: true

  Maximum Length: 30

  Name of the supply plan that was used to generate the collaboration order forecast.
• SupplyPlanVersion: integer (int32)
  Read Only: true

  Version of the supply plan that was used to generate the collaboration order forecast.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Unit of measure for the item.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the item.

{
    "type":"object",
    "properties":{
        "PlanningCycleEndDate":{
            "type":"string",
            "description":"Date when the collaboration planning cycle ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the collaboration order forecast.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteToSupplier":{
            "maxLength":"1000",
            "type":"string",
            "description":"Note provided by the collaboration planner to the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "CollaborationSourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToCustomerName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteToPlanner":{
            "maxLength":"1000",
            "type":"string",
            "description":"Note provided by the supplier to the collaboration planner.",
            "nullable":true,
            "x-queryable":true
        },
        "exceptionQuantities":{
            "title":"Exception Quantities",
            "type":"array",
            "description":"The Exception Quantities resource gets the forecast and commit exceptions associated with the collaboration order forecast, such as, forecast changes and commit mismatches.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecasts-exceptionQuantities-item-response"
            }
        },
        "PlanningCycleStartDate":{
            "type":"string",
            "description":"Date when the collaboration planning cycle begins.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the current state of the collaboration order forecast. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCategory":{
            "maxLength":"255",
            "type":"string",
            "description":"Category that the application assigns to the item from the default planning catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierOnHandPublishedByUserName":{
            "title":"User Name",
            "maxLength":"100",
            "type":"string",
            "description":"User who most recently published the supplier on-hand quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToSupplierName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "B2BOnlyFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the collaboration order forecast was published to the supplier using only B2B messaging. If false, then B2B messaging wasn't the only method to publish the collaboration order forecast. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CollaborationPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration plan scenario.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "forecastQuantities":{
            "title":"Forecast Quantities",
            "type":"array",
            "description":"The Forecast Quantities resource gets the current forecast measure details associated with the collaboration order forecast. This resource can also be used to update or create new forecast quantities for collaboration order forecasts.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecasts-forecastQuantities-item-response"
            }
        },
        "ShipToSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who receives the item. It's a primary key that the application generates when it creates the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyPlanName":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the supply plan that was used to generate the collaboration order forecast.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromSupplierAlternateName":{
            "type":"string",
            "description":"Alternate name of the supplier that ships the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"number_edit",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the current state of the collaboration order forecast. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Login of the user who most recently updated the collaboration order forecast.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromSupplierNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the supplier that ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerName":{
            "maxLength":"100",
            "type":"string",
            "description":"Name of the manufacturer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the collaboration order forecast.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"User who most recently published the collaboration order forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DropShipFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the collaboration order forecast data is for a drop ship relationship. If false, then the collaboration order forecast data isn't for a drop ship relationship. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the inventory item in the relationship candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Number that identifies the item at the manufacturer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OnHandPublishedByUserName":{
            "title":"User Name",
            "maxLength":"100",
            "type":"string",
            "description":"User who most recently published the on-hand quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyPlanVersion":{
            "type":"integer",
            "description":"Version of the supply plan that was used to generate the collaboration order forecast.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ForecastTotalCommitHorizonQuantity":{
            "type":"number",
            "description":"Sum of the forecast quantities over the commit horizon for a collaboration order forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommitTotalQuantity":{
            "type":"number",
            "description":"Sum of the commit quantities over the commit horizon for a collaboration order forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollaborationPlanName":{
            "title":"Name",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the collaboration plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToCustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site who will receive the item. It's a primary key that the application creates when it creates the customer site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the item referred to by the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyPlanDescription":{
            "maxLength":"100",
            "type":"string",
            "description":"Description of the supply plan that was used to generate the collaboration order forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site in the relationship. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer who will receive the item. It's a primary key that the application creates when it creates the customer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OnHandQuantity":{
            "type":"number",
            "description":"Quantity of the on-hand inventory for the collaboration order forecast item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrelationCode":{
            "maxLength":"64",
            "type":"string",
            "description":"Abbreviation that identifies the orchestration process instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OnHandPublishedDate":{
            "type":"string",
            "description":"Date when the on-hand quantity was published.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToCustomerSiteName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer site that received the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToSupplierSiteName":{
            "title":"Site",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier site in the collaboration order forecast that receives the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToOrganizationId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the organization in the collaboration order forecast. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierOnHandPublishedDate":{
            "type":"string",
            "description":"Date when the supplier on-hand quantity was published.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierOnHandQuantity":{
            "type":"number",
            "description":"Quantity of the supplier's on-hand inventory for the collaboration order forecast item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastTotalForecastHorizonQuantity":{
            "type":"number",
            "description":"Sum of the forecast quantities over the forecast horizon for a collaboration order forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommitDate":{
            "type":"string",
            "description":"Date when the supply was committed against the collaboration order forecast.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "referenceQuantities":{
            "title":"Reference Quantities",
            "type":"array",
            "description":"The Reference Quantities resource gets the additional measures associated with the collaboration order forecast, such as, purchasing measures.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecasts-referenceQuantities-item-response"
            }
        },
        "CollaborationCycleVersion":{
            "type":"integer",
            "description":"Version of the collaboration planning cycle.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CommitDueDate":{
            "type":"string",
            "description":"Date when the supply commits are due for the collaboration order forecast.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromSupplierDUNS":{
            "maxLength":"30",
            "type":"string",
            "description":"Data universal numbering system of the supplier who ships the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromSupplierSiteName":{
            "title":"Site",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person that created the collaboration order forecast.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "commitQuantities":{
            "title":"Commit Quantities",
            "type":"array",
            "description":"The Commit Quantities resource gets the current commit measure details associated with the collaboration order forecast. This resource can also be used to respond to collaboration order forecasts by providing supply commits.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecasts-commitQuantities-item-response"
            }
        },
        "ShipToSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site in the collaboration order forecast. This supplier site sends the shipment. It's a primary key that the application generates when it creates the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipFromSupplierName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier that ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier to this business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemCode":{
            "title":"Lookup Code",
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedDate":{
            "type":"string",
            "description":"Date when the collaboration order forecast was published.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the most recent user to publish the collaboration order forecast.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Meaning",
            "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
        },
        "ShipToOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the collaboration order forecast.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Commit Quantities

Type: array

Title: Commit Quantities

The Commit Quantities resource gets the current commit measure details associated with the collaboration order forecast. This resource can also be used to respond to collaboration order forecasts by providing supply commits.

Show Source

• Array of: object collaborationOrderForecasts-commitQuantities-item-response

{
    "title":"Commit Quantities",
    "type":"array",
    "description":"The Commit Quantities resource gets the current commit measure details associated with the collaboration order forecast. This resource can also be used to respond to collaboration order forecasts by providing supply commits.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecasts-commitQuantities-item-response"
    }
}

Nested Schema : Exception Quantities

Type: array

Title: Exception Quantities

The Exception Quantities resource gets the forecast and commit exceptions associated with the collaboration order forecast, such as, forecast changes and commit mismatches.

Show Source

• Array of: object collaborationOrderForecasts-exceptionQuantities-item-response

{
    "title":"Exception Quantities",
    "type":"array",
    "description":"The Exception Quantities resource gets the forecast and commit exceptions associated with the collaboration order forecast, such as, forecast changes and commit mismatches.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecasts-exceptionQuantities-item-response"
    }
}

Nested Schema : Forecast Quantities

Type: array

Title: Forecast Quantities

The Forecast Quantities resource gets the current forecast measure details associated with the collaboration order forecast. This resource can also be used to update or create new forecast quantities for collaboration order forecasts.

Show Source

• Array of: object collaborationOrderForecasts-forecastQuantities-item-response

{
    "title":"Forecast Quantities",
    "type":"array",
    "description":"The Forecast Quantities resource gets the current forecast measure details associated with the collaboration order forecast. This resource can also be used to update or create new forecast quantities for collaboration order forecasts.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecasts-forecastQuantities-item-response"
    }
}

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 : Reference Quantities

Type: array

Title: Reference Quantities

The Reference Quantities resource gets the additional measures associated with the collaboration order forecast, such as, purchasing measures.

Show Source

• Array of: object collaborationOrderForecasts-referenceQuantities-item-response

{
    "title":"Reference Quantities",
    "type":"array",
    "description":"The Reference Quantities resource gets the additional measures associated with the collaboration order forecast, such as, purchasing measures.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecasts-referenceQuantities-item-response"
    }
}

Nested Schema : collaborationOrderForecasts-commitQuantities-item-response

Type: object

Show Source

• BucketAggregationCode: string
  Maximum Length: 32

  Abbreviation that identifies the bucket aggregation type for the commit quantity. A list of accepted values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• BucketEndDate: string (date)
  Date when the time bucket ends.
• BucketId: integer (int64)
  Read Only: true

  Value that uniquely identifies the time bucket.
• BucketStartDate: string (date)
  Date when the time bucket starts.
• CollaborationOrderForecastDetailsId: integer (int64)
  Value that uniquely identifies the collaboration order forecast details record.
• CollaborationOrderForecastId: integer (int64)
  Value that uniquely identifies the collaboration order forecast.
• CommitDate: string (date-time)
  Date when the user most recently committed the commit quantity.
• CommitMismatchReason: string
  Read Only: true

  Maximum Length: 80

  Reason the supplier couldn't commit to the forecast, thereby creating a mismatch between the request and the response
• CommitMismatchReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the reason the supplier couldn't commit to the forecast, thereby creating a mismatch between the request and the response.
• CommittedByPartyCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of user who performed the commit action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• CommittedByPersonId: integer (int64)
  Value that uniquely identifies the user who committed the commit quantity.
• CommittedByUserName: string
  Read Only: true

  Maximum Length: 255

  User who committed the commit quantity.
• CorrelationCode: string
  Maximum Length: 64

  Abbreviation that uniquely identifies the orchestration process instance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Quantity: number
  Quantity of the supplier commit.
• Version: integer (int32)
  Version of the commit time bucket for the collaboration order forecast.

{
    "type":"object",
    "properties":{
        "CommitMismatchReason":{
            "maxLength":"80",
            "type":"string",
            "description":"Reason the supplier couldn't commit to the forecast, thereby creating a mismatch between the request and the response",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommittedByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"User who committed the commit quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommittedByPartyCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of user who performed the commit action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "CommitMismatchReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason the supplier couldn't commit to the forecast, thereby creating a mismatch between the request and the response.",
            "nullable":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the supplier commit.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketId":{
            "type":"integer",
            "description":"Value that uniquely identifies the time bucket.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BucketAggregationCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the bucket aggregation type for the commit quantity. A list of accepted values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastDetailsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast details record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorrelationCode":{
            "maxLength":"64",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the orchestration process instance.",
            "nullable":true,
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"Version of the commit time bucket for the collaboration order forecast.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BucketEndDate":{
            "type":"string",
            "description":"Date when the time bucket ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BucketStartDate":{
            "type":"string",
            "description":"Date when the time bucket starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CommitDate":{
            "type":"string",
            "description":"Date when the user most recently committed the commit quantity.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CommittedByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who committed the commit quantity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

Nested Schema : collaborationOrderForecasts-exceptionQuantities-item-response

Type: object

Show Source

• BucketAggregationCode: string
  Read Only: true

  Maximum Length: 32

  Abbreviation that identifies the bucket aggregation type for the exception quantity. A list of accepted values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• BucketEndDate: string (date)
  Read Only: true

  Date when the time bucket ends.
• BucketId: integer (int64)
  Read Only: true

  Value that uniquely identifies the time bucket.
• BucketStartDate: string (date)
  Read Only: true

  Date when the time bucket starts.
• CollaborationOrderForecastId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration order forecast.
• ExceptionFactor: number
  Value that identifies the amount of change based on the exception type.
• ExceptionId: integer (int64)
  Value that uniquely identifies the collaboration order forecast exception.
• ExceptionTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the exception type. Values include COMMIT_MISMATCH or FORECAST_DEVIATION.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumCommitVersion: integer (int32)
  Version of the maximum commit when the exception occurred for the aggregation type.
• MaximumForecastVersion: integer (int32)
  Version of the maximum forecast when the exception occurred for the aggregation type.
• PrimaryExceptionVariable: number
  Value that's used in the calculation of the exception factor.
• SecondaryExceptionVariable: number
  Value that's used in the calculation of the exception factor.

{
    "type":"object",
    "properties":{
        "MaximumForecastVersion":{
            "type":"integer",
            "description":"Version of the maximum forecast when the exception occurred for the aggregation type.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CollaborationOrderForecastId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryExceptionVariable":{
            "type":"number",
            "description":"Value that's used in the calculation of the exception factor.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketId":{
            "type":"integer",
            "description":"Value that uniquely identifies the time bucket.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BucketAggregationCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the bucket aggregation type for the exception quantity. A list of accepted values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExceptionTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the exception type. Values include COMMIT_MISMATCH or FORECAST_DEVIATION.",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionFactor":{
            "type":"number",
            "description":"Value that identifies the amount of change based on the exception type.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketEndDate":{
            "type":"string",
            "description":"Date when the time bucket ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BucketStartDate":{
            "type":"string",
            "description":"Date when the time bucket starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumCommitVersion":{
            "type":"integer",
            "description":"Version of the maximum commit when the exception occurred for the aggregation type.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PrimaryExceptionVariable":{
            "type":"number",
            "description":"Value that's used in the calculation of the exception factor.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : collaborationOrderForecasts-forecastQuantities-item-response

Type: object

Show Source

• BucketAggregationCode: string
  Maximum Length: 32

  Abbreviation that identifies the bucket aggregation type for the forecast quantity. A list of accepted values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• BucketEndDate: string (date)
  Date when the time bucket ends.
• BucketId: integer (int64)
  Read Only: true

  Value that uniquely identifies the time bucket.
• BucketStartDate: string (date)
  Date when the time bucket starts.
• CollaborationOrderForecastDetailsId: integer (int64)
  Value that uniquely identifies the collaboration order forecast details record.
• CollaborationOrderForecastId: integer (int64)
  Value that uniquely identifies the collaboration order forecast.
• CorrelationCode: string
  Maximum Length: 64

  Abbreviation that uniquely identifies the orchestration process instance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PublishedByPersonId: integer (int64)
  Read Only: true

  Value that uniquely identifies the user who most recently published the forecast quantity.
• PublishedByUserName: string
  Maximum Length: 64

  User who most recently published the forecast quantity.
• PublishedDate: string (date-time)
  Date when the forecast quantity was published.
• PublishSourceCode: string
  Maximum Length: 32

  Abbreviation that identifies the type of user who performed the publish action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• Quantity: number
  Quantity of the supply forecast.
• Version: integer (int32)
  Version of the forecast time bucket for the collaboration order forecast.

{
    "type":"object",
    "properties":{
        "PublishedByUserName":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently published the forecast quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the supply forecast.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketId":{
            "type":"integer",
            "description":"Value that uniquely identifies the time bucket.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BucketAggregationCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the bucket aggregation type for the forecast quantity. A list of accepted values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastDetailsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast details record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorrelationCode":{
            "maxLength":"64",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the orchestration process instance.",
            "nullable":true,
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"Version of the forecast time bucket for the collaboration order forecast.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BucketEndDate":{
            "type":"string",
            "description":"Date when the time bucket ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BucketStartDate":{
            "type":"string",
            "description":"Date when the time bucket starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PublishedDate":{
            "type":"string",
            "description":"Date when the forecast quantity was published.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublishSourceCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the type of user who performed the publish action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "PublishedByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who most recently published the forecast quantity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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 : collaborationOrderForecasts-referenceQuantities-item-response

Type: object

Show Source

• BucketEndDate: string (date)
  Read Only: true

  Date when the time bucket ends.
• BucketId: integer (int64)
  Read Only: true

  Value that uniquely identifies the time bucket.
• BucketStartDate: string (date)
  Title: Date

  Read Only: true

  Date when the time bucket starts.
• CollaborationOrderForecastId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration order forecast.
• DocumentReferenceNumber: string
  Title: Reference Number

  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the document reference order type. The format is Header(Line)(Location).
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureName: string
  Title: Measure

  Read Only: true

  Maximum Length: 80

  Name of the measure.
• PublishDate: string (date-time)
  Date when the forecast quantity was published.
• PublishedByPersonId: integer (int64)
  Read Only: true

  Value that uniquely identifies the user who most recently published the forecast quantity.
• PublishedByUserName: string
  Maximum Length: 64

  User who most recently published the forecast quantity.
• PublisherOrderTypeCode: string
  Maximum Length: 32

  Abbreviation that identifies the order type of the reference quantity. A list of accepted values is defined in the lookup type ORA_VCS_COLLAB_ORDER_TYPES. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• PublishSourceCode: string
  Maximum Length: 32

  Abbreviation that identifies the type of user who performed the commit. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• Quantity: number
  Title: Quantity

  Quantity of the related order type.
• RefercenceDetailsId: integer (int64)
  Value that uniquely identifies the collaboration order forecast reference details record.
• ReferenceHeaderId: integer (int64)
  Value that uniquely identifies the reference header for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineId: integer (int64)
  Value that uniquely identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineLocationId: integer (int64)
  Value that uniquely identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.

{
    "type":"object",
    "properties":{
        "PublisherOrderTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the order type of the reference quantity. A list of accepted values is defined in the lookup type ORA_VCS_COLLAB_ORDER_TYPES. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "PublishDate":{
            "type":"string",
            "description":"Date when the forecast quantity was published.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublishedByUserName":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently published the forecast quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "MeasureName":{
            "title":"Measure",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the related order type.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketId":{
            "type":"integer",
            "description":"Value that uniquely identifies the time bucket.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference header for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RefercenceDetailsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast reference details record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the document reference order type. The format is Header(Line)(Location).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BucketEndDate":{
            "type":"string",
            "description":"Date when the time bucket ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BucketStartDate":{
            "title":"Date",
            "type":"string",
            "description":"Date when the time bucket starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishSourceCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the type of user who performed the commit. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "PublishedByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who most recently published the forecast quantity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

Links

commitQuantities

Operation: /fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts/{CollaborationOrderForecastId}/child/commitQuantities

Parameters:

• CollaborationOrderForecastId: $request.path.CollaborationOrderForecastId

The Commit Quantities resource gets the current commit measure details associated with the collaboration order forecast. This resource can also be used to respond to collaboration order forecasts by providing supply commits.

exceptionQuantities

Operation: /fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts/{CollaborationOrderForecastId}/child/exceptionQuantities

Parameters:

• CollaborationOrderForecastId: $request.path.CollaborationOrderForecastId

The Exception Quantities resource gets the forecast and commit exceptions associated with the collaboration order forecast, such as, forecast changes and commit mismatches.

forecastQuantities

Operation: /fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts/{CollaborationOrderForecastId}/child/forecastQuantities

Parameters:

• CollaborationOrderForecastId: $request.path.CollaborationOrderForecastId

The Forecast Quantities resource gets the current forecast measure details associated with the collaboration order forecast. This resource can also be used to update or create new forecast quantities for collaboration order forecasts.

referenceQuantities

Operation: /fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts/{CollaborationOrderForecastId}/child/referenceQuantities

Parameters:

• CollaborationOrderForecastId: $request.path.CollaborationOrderForecastId

The Reference Quantities resource gets the additional measures associated with the collaboration order forecast, such as, purchasing measures.

Back to Top

Examples

This example describes how to get one collaboration order forecast.

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/collaborationOrderForecasts/CollaborationOrderForecastId"

For example, the following command gets one collaboration order forecast where the collaboration order forecast identifier is 6017:

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationOrderForecasts/6017"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"CollaborationOrderForecastId": 6017,
		"CorrelationCode": "300100150703462",
		"SupplyPlanName": "US_Production",
		"SupplyPlanDescription": "US Production Plan",
		"SupplyPlanVersion": null,
		"SourceSystemCode": "ORA_VCS_SRCSYSTEM_ORACLE",
		"SourceSystem": "Oracle",
		"CollaborationSourceId": 3005,
		"CollaborationPlanId": 300100120934736,
		"CollaborationPlanName": "BAT_SCC_Plan01",
		"PlanningCycleStartDate": "2019-06-24",
		"PlanningCycleEndDate": "2020-06-07",
		"ShipFromSupplierId": 415,
		"ShipFromSupplierName": "CV_SuppA03",
		"ShipFromSupplierNumber": "5017",
		"ShipFromSupplierDUNS": "9876543210234",
		"ShipFromSupplierAlternateName": null,
		"ShipFromSupplierSiteId": 1395,
		"ShipFromSupplierSiteName": "CVSuppA03Site01",
		"ProcurementBUId": 204,
		"ProcurementBUName": "Vision Operations",
		"ShipToOrganizationId": "207",
		"ShipToOrganizationCode": "M1",
		"ShipToOrganizationName": "Manufacturing 1",
		"ShipToSupplierId": 415,
		"ShipToSupplierName": "CV_SuppA03",
		"ShipToSupplierSiteId": null,
		"ShipToSupplierSiteName": null,
		"ShipToCustomerId": null,
		"ShipToCustomerName": null,
		"ShipToCustomerSiteId": null,
		"ShipToCustomerSiteName": null,
		"InventoryItemId": "300100082371759",
		"ItemNumber": "SCC-100GB",
		"ItemDescription": "SCC 100 GB HD",
		"ItemCategory": "Uncategorized",
		"UOMCode": "Ea",
		"UnitOfMeasure": "Each",
		"SupplierItemNumber": null,
		"ForecastTotalForecastHorizonQuantity": 882,
		"ForecastTotalCommitHorizonQuantity": 882,
		"CommitTotalQuantity": null,
		"OnHandQuantity": null,
		"SupplierOnHandQuantity": null,
		"SupplierOnHandPublishedDate": null,
		"SupplierOnHandPublishedByUserName": null,
		"PublishedDate": "2019-08-29T18:45:03+00:00",
		"PublishedByPersonId": 300100073936640,
		"PublishedByUserName": "COLLABPLANNER",
		"OnHandPublishedDate": "2019-08-29T18:45:03+00:00",
		"OnHandPublishedByUserName": "COLLABPLANNER",
		"CommitDate": null,
		"CommitDueDate": null,
		"Status": "Completed",
		"StatusCode": "ORA_VCS_COMPLETED",
		"CollaborationCycleVersion": 3,
		"CreatedByPersonId": 300100073936640,
		"CreatedBy": "COLLABPLANNER",
		"CreationDate": "2019-08-29T18:45:03+00:00",
		"LastUpdatedBy": "COLLABPLANNER",
		"LastUpdateDate": "2019-09-09T14:37:21.374+00:00",
		"B2BOnlyFlag": "false",
		"DropShipFlag": "false",
		"links": [
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		},
		{
			...
		}
		]
	}
}

Back to Top