Jump to

• Request
• Response
• Examples

Get all forecasts

get

/fscmRestApi/resources/11.13.18.05/collaborationOrderForecastHistory

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Find collaboration order forecasts according to the primary key.
    Finder Variables
    • CollaborationOrderForecastEntryId; integer; Value that uniquely identifies the request.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CollaborationCycleVersion; integer; Version of the collaboration planning cycle.
  • CollaborationOrderForecastEntryId; integer; Value that uniquely identifies the historical collaboration order forecast entry.
  • CollaborationOrderForecastId; integer; Value that uniquely identifies the collaboration order forecast.
  • CollaborationPlanId; string; Value that uniquely identifies the collaboration plan scenario.
  • CollaborationSourceId; string; Value that uniquely identifies the collaboration plan.
  • CommitDate; string; Date when the supply was committed against the collaboration order forecast.
  • CommitDueDate; string; Date when the supply commits are due for the collaboration order forecast.
  • CommitTotalQuantity; number; Sum of the commit quantities over the commit horizon for a collaboration order forecast.
  • CorrelationCode; string; Abbreviation that identifies the orchestration process instance.
  • CreatedBy; string; User who created the collaboration order forecast.
  • CreatedByPersonId; integer; Value that uniquely identifies the person that created the collaboration order forecast.
  • CreationDate; string; Date and time when the user created the collaboration order forecast.
  • DropShipFlag; boolean; 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.
  • ForecastTotalCommitHorizonQuantity; number; Sum of the forecast quantities over the commit horizon for a collaboration order forecast.
  • ForecastTotalForecastHorizonQuantity; number; Sum of the forecast quantities over the forecast horizon for a collaboration order forecast.
  • InventoryItemId; integer; Value that uniquely identifies the inventory item in the relationship candidate.
  • ItemDescription; string; Description of the item.
  • ItemNumber; string; Number of the item.
  • LastUpdateDate; string; Date and time when the user most recently updated the collaboration order forecast.
  • LastUpdatedBy; string; Login of the user who most recently updated the collaboration order forecast.
  • ManufacturerName; string; Name of the manufacturer.
  • ManufacturerPartNumber; string; Number that identifies the item at the manufacturer.
  • NoteToPlanner; string; Note provided by the supplier to the collaboration planner.
  • NoteToSupplier; string; Note provided by the collaboration planner to the supplier.
  • PlanningCycleEndDate; string; Date when the collaboration planning cycle ends.
  • PlanningCycleStartDate; string; Date when the collaboration planning cycle begins.
  • ProcurementBUId; integer; Value that uniquely identifies the business unit.
  • ProcurementBUName; string; Name of the business unit. The application assigns the supplier to this business unit.
  • PublishedByPersonId; integer; Value that uniquely identifies the most recent user to publish the collaboration order forecast.
  • PublishedByUserName; string; User who most recently published the collaboration order forecast.
  • PublishedDate; string; Date when the collaboration order forecast was published.
  • ShipFromSupplierAlternateName; string; Alternate name of the supplier that ships the item.
  • ShipFromSupplierDUNS; string; Data universal numbering system, otherwise known as D-U-N-S of the supplier who ships the item.
  • ShipFromSupplierId; integer; 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; Name of the supplier that ships the item.
  • ShipFromSupplierNumber; string; Number of the supplier that ships the item.
  • ShipFromSupplierSiteId; integer; 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; Name of the supplier site that ships the item.
  • ShipToCustomerId; integer; 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; Name of the customer that receives the item.
  • ShipToCustomerSiteId; integer; 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; Name of the customer site that received the item.
  • ShipToOrganizationCode; string; Abbreviation that identifies the organization that receives the item.
  • ShipToOrganizationId; integer; 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; Name of the organization that receives the item.
  • ShipToSupplierId; integer; 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; Name of the supplier that receives the item.
  • ShipToSupplierSiteId; integer; 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; Name of the supplier site in the in the collaboration order forecast that receives the item.
  • SourceSystem; string; Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
  • SourceSystemCode; string; Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.
  • SupplierItemNumber; string; Number that identifies the item referred to by the supplier.
  • SupplyPlanName; string; Name of the supply plan that was used to generate the collaboration order forecast.
  • UOMCode; string; Abbreviation that identifies the unit of measure for the item.
  • UnitOfMeasure; string; Unit of measure for the item.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to 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 : collaborationOrderForecastHistory

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecastHistory-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object collaborationOrderForecastHistory-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecastHistory-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 : collaborationOrderForecastHistory-item-response

Type: object

Show Source

• aggregatedQuantities: array Aggregated Quantities
  Title: Aggregated Quantities

  The Aggregated Quantities resource gets the aggregated forecast quantities and commit quantities associated with the historical planning cycles of collaboration order forecasts in weekly, monthly, or quarterly increments.
• CollaborationCycleVersion: integer (int32)
  Version of the collaboration planning cycle.
• CollaborationOrderForecastEntryId: integer (int64)
  Value that uniquely identifies the historical collaboration order forecast entry.
• CollaborationOrderForecastId: integer (int64)
  Value that uniquely identifies the collaboration order forecast.
• CollaborationPlanId: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the collaboration plan scenario.
• CollaborationSourceId: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the collaboration plan.
• CommitDate: string (date-time)
  Date when the supply was committed against the collaboration order forecast.
• CommitDueDate: string (date-time)
  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 commit measure details associated with the historical planning cycles of collaboration order forecasts.
• CommitTotalQuantity: number
  Sum of the commit quantities over the commit horizon for a collaboration order forecast.
• CorrelationCode: string
  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.
• forecastQuantities: array Forecast Quantities
  Title: Forecast Quantities

  The Forecast Quantities resource gets the forecast measure details associated with the historical planning cycles of collaboration order forecasts.
• ForecastTotalCommitHorizonQuantity: number
  Sum of the forecast quantities over the commit horizon for a collaboration order forecast.
• ForecastTotalForecastHorizonQuantity: number
  Sum of the forecast quantities over the forecast horizon for a collaboration order forecast.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item in the relationship candidate.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

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

  Maximum Length: 255

  Number of 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
  Read Only: true

  Maximum Length: 1000

  Note provided by the supplier to the collaboration planner.
• NoteToSupplier: string
  Read Only: true

  Maximum Length: 1000

  Note provided by the collaboration planner to the supplier.
• PlanningCycleEndDate: string (date)
  Date when the collaboration planning cycle ends.
• PlanningCycleStartDate: string (date)
  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)
  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)
  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, otherwise known as D-U-N-S 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 of 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: integer (int64)
  Read Only: true

  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 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.
• SupplierItemNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the item referred to by the supplier.
• SupplyPlanName: string
  Read Only: true

  Maximum Length: 64

  Name 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
  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,
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "CollaborationSourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the collaboration plan.",
            "nullable":true,
            "readOnly":true,
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleStartDate":{
            "type":"string",
            "description":"Date when the collaboration planning cycle begins.",
            "format":"date",
            "nullable":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CollaborationPlanId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the collaboration plan scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "forecastQuantities":{
            "title":"Forecast Quantities",
            "type":"array",
            "description":"The Forecast Quantities resource gets the forecast measure details associated with the historical planning cycles of collaboration order forecasts.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecastHistory-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,
            "x-queryable":true
        },
        "SupplyPlanName":{
            "maxLength":"64",
            "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
        },
        "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 of 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":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item in the relationship candidate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Number that identifies the item at the manufacturer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastEntryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the historical collaboration order forecast entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ForecastTotalCommitHorizonQuantity":{
            "type":"number",
            "description":"Sum of the forecast quantities over the commit horizon for a collaboration order forecast.",
            "nullable":true,
            "x-queryable":true
        },
        "CommitTotalQuantity":{
            "type":"number",
            "description":"Sum of the commit quantities over the commit horizon for a collaboration order forecast.",
            "nullable":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
        },
        "CollaborationOrderForecastId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast.",
            "format":"int64",
            "nullable":true,
            "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
        },
        "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
        },
        "CorrelationCode":{
            "maxLength":"64",
            "type":"string",
            "description":"Abbreviation that identifies the orchestration process instance.",
            "nullable":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 in the collaboration order forecast that receives the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToOrganizationId":{
            "type":"integer",
            "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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization that receives the 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,
            "x-queryable":true
        },
        "aggregatedQuantities":{
            "title":"Aggregated Quantities",
            "type":"array",
            "description":"The Aggregated Quantities resource gets the aggregated forecast quantities and commit quantities associated with the historical planning cycles of collaboration order forecasts in weekly, monthly, or quarterly increments.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecastHistory-aggregatedQuantities-item-response"
            }
        },
        "CommitDate":{
            "type":"string",
            "description":"Date when the supply was committed against the collaboration order forecast.",
            "format":"date-time",
            "nullable":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/collaborationOrderForecastHistory-referenceQuantities-item-response"
            }
        },
        "CollaborationCycleVersion":{
            "type":"integer",
            "description":"Version of the collaboration planning cycle.",
            "format":"int32",
            "nullable":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,
            "x-queryable":true
        },
        "ShipFromSupplierDUNS":{
            "maxLength":"30",
            "type":"string",
            "description":"Data universal numbering system, otherwise known as D-U-N-S 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 commit measure details associated with the historical planning cycles of collaboration order forecasts.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecastHistory-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,
            "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,
            "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 : Aggregated Quantities

Type: array

Title: Aggregated Quantities

The Aggregated Quantities resource gets the aggregated forecast quantities and commit quantities associated with the historical planning cycles of collaboration order forecasts in weekly, monthly, or quarterly increments.

Show Source

• Array of: object collaborationOrderForecastHistory-aggregatedQuantities-item-response

{
    "title":"Aggregated Quantities",
    "type":"array",
    "description":"The Aggregated Quantities resource gets the aggregated forecast quantities and commit quantities associated with the historical planning cycles of collaboration order forecasts in weekly, monthly, or quarterly increments.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecastHistory-aggregatedQuantities-item-response"
    }
}

Nested Schema : Commit Quantities

Type: array

Title: Commit Quantities

The Commit Quantities resource gets the commit measure details associated with the historical planning cycles of collaboration order forecasts.

Show Source

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

{
    "title":"Commit Quantities",
    "type":"array",
    "description":"The Commit Quantities resource gets the commit measure details associated with the historical planning cycles of collaboration order forecasts.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecastHistory-commitQuantities-item-response"
    }
}

Nested Schema : Forecast Quantities

Type: array

Title: Forecast Quantities

The Forecast Quantities resource gets the forecast measure details associated with the historical planning cycles of collaboration order forecasts.

Show Source

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

{
    "title":"Forecast Quantities",
    "type":"array",
    "description":"The Forecast Quantities resource gets the forecast measure details associated with the historical planning cycles of collaboration order forecasts.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecastHistory-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 collaborationOrderForecastHistory-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/collaborationOrderForecastHistory-referenceQuantities-item-response"
    }
}

Nested Schema : collaborationOrderForecastHistory-aggregatedQuantities-item-response

Type: object

Show Source

• BucketAggregationCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the bucket aggregation type for the aggregated 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)
  Value that uniquely identifies the time bucket.
• BucketStartDate: string (date)
  Read Only: true

  Date when the time bucket starts.
• CollaborationOrderForecastEntryId: integer (int64)
  Value that uniquely identifies the historical collaboration order forecast entry.
• CollaborationOrderForecastId: integer (int64)
  Value that uniquely identifies the collaboration order forecast.
• CommitMismatchFactor: number
  Read Only: true

  Identifies the amount of difference between current commit and current forecast quantities when the current commit is less than current forecast for the bucket aggregation level.
• CommitQuantity: number
  Most recent commit quantity of the aggregation type.
• EntryDetailId: integer (int64)
  Value that uniquely identifies the historical entry detail.
• ForecastChangeFactor: number
  Read Only: true

  Measures the amount of difference between current forecast and the previous forecast quantities for the bucket aggregation level.
• ForecastQuantity: number
  Most recent forecast quantity of the aggregation type.
• 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.

{
    "type":"object",
    "properties":{
        "CommitQuantity":{
            "type":"number",
            "description":"Most recent commit quantity of the aggregation type.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "ForecastChangeFactor":{
            "type":"number",
            "description":"Measures the amount of difference between current forecast and the previous forecast quantities for the bucket aggregation level.",
            "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
        },
        "BucketAggregationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the bucket aggregation type for the aggregated 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
        },
        "CommitMismatchFactor":{
            "type":"number",
            "description":"Identifies the amount of difference between current commit and current forecast quantities when the current commit is less than current forecast for the bucket aggregation level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BucketId":{
            "type":"integer",
            "description":"Value that uniquely identifies the time bucket.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EntryDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the historical entry detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollaborationOrderForecastEntryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the historical collaboration order forecast entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "ForecastQuantity":{
            "type":"number",
            "description":"Most recent forecast quantity of the aggregation type.",
            "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 : 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 : collaborationOrderForecastHistory-commitQuantities-item-response

Type: object

Show Source

• BucketAggregationCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  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)
  Read Only: true

  Date when the time bucket ends.
• BucketId: integer (int64)
  Value that uniquely identifies the time bucket.
• BucketStartDate: string (date)
  Read Only: true

  Date when the time bucket starts.
• CollaborationOrderForecastDetailsId: integer (int64)
  Value that uniquely identifies the collaboration order forecast details record.
• CommitDate: string (date-time)
  Most recent date when the user committed the commit quantity.
• 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
  Read Only: true

  Maximum Length: 64

  Abbreviation that uniquely identifies the orchestration process instance.
• IsLastPublishedFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then the commit quantity is associated with the most recent published cycle of the collaboration order forecast. If false, then the commit quantity isn't associated with the most recent published cycle of the collaboration order forecast. This attribute doesn't have a default value.
• 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":{
        "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
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the supplier commit.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketAggregationCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BucketId":{
            "type":"integer",
            "description":"Value that uniquely identifies the time bucket.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "IsLastPublishedFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the commit quantity is associated with the most recent published cycle of the collaboration order forecast. If false, then the commit quantity isn't associated with the most recent published cycle of the collaboration order forecast. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":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,
            "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
        },
        "CommitDate":{
            "type":"string",
            "description":"Most recent date when the user 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 : collaborationOrderForecastHistory-forecastQuantities-item-response

Type: object

Show Source

• BucketAggregationCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  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)
  Read Only: true

  Date when the time bucket ends.
• BucketId: integer (int64)
  Value that uniquely identifies the time bucket.
• BucketStartDate: string (date)
  Read Only: true

  Date when the time bucket starts.
• CollaborationOrderForecastDetailsId: integer (int64)
  Value that uniquely identifies the collaboration order forecast details record.
• IsLastPublishedFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then the forecast quantity is associated with the most recent published cycle of the collaboration order forecast. If false, then the forecast quantity isn't associated with the most recent published cycle of the collaboration order forecast. This attribute doesn't have a default value.
• 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
  Title: User Name

  Read Only: true

  Maximum Length: 100

  User who most recently published the forecast quantity.
• PublishedDate: string (date-time)
  Publish date of the forecast quantity.
• 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":{
            "title":"User Name",
            "maxLength":"100",
            "type":"string",
            "description":"User who most recently published the forecast quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the supply forecast.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketAggregationCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BucketId":{
            "type":"integer",
            "description":"Value that uniquely identifies the time bucket.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "IsLastPublishedFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the forecast quantity is associated with the most recent published cycle of the collaboration order forecast. If false, then the forecast quantity isn't associated with the most recent published cycle of the collaboration order forecast. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":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,
            "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
        },
        "PublishedDate":{
            "type":"string",
            "description":"Publish date of the forecast quantity.",
            "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 : collaborationOrderForecastHistory-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)
  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
  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.
• PublishDate: string (date-time)
  Read Only: true

  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
  Read Only: true

  Maximum Length: 64

  User who most recently published the forecast quantity.
• PublisherOrderTypeCode: string
  Read Only: true

  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
  Read Only: true

  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
  Read Only: true

  Quantity of the related order type.
• ReferenceDetailsId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration order forecast reference details record.

{
    "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,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishDate":{
            "type":"string",
            "description":"Date when the forecast quantity was published.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedByUserName":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently published the forecast quantity.",
            "nullable":true,
            "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
        },
        "ReferenceDetailsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration order forecast reference details record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the related order type.",
            "nullable":true,
            "readOnly":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
        },
        "DocumentReferenceNumber":{
            "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":{
            "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,
            "readOnly":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"
    }
}

Back to Top

Examples

This example describes how to get all forecasts.

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/collaborationOrderForecastHistory"

Example Response Body

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

{
    "items": [
        {
            "CollaborationOrderForecastEntryId": 4088,
            "CollaborationOrderForecastId": 162,
            "CorrelationCode": "300100122481862",
            "SupplyPlanName": null,
            "CollaborationSourceId": 3008,
            "CollaborationPlanId": 300100120934769,
            "PlanningCycleStartDate": "2017-08-21",
            "PlanningCycleEndDate": "2017-08-27",
            "ShipFromSupplierId": 230,
            "ShipFromSupplierName": "CV_SuppA00",
            "ShipFromSupplierNumber": "5001",
            "ShipFromSupplierDUNS": "987654321",
            "ShipFromSupplierAlternateName": null,
            "ShipFromSupplierSiteId": 5232,
            "ShipFromSupplierSiteName": "CVSuppA00Site01",
            "ProcurementBUId": 204,
            "ProcurementBUName": "Vision Corporation",
            "ShipToOrganizationId": 207,
            "ShipToOrganizationCode": "M1",
            "ShipToOrganizationName": "Manufacturing 1",
            "ShipToSupplierSiteId": null,
            "ShipToSupplierSiteName": null,
            "ShipToCustomerId": null,
            "ShipToCustomerName": null,
            "ShipToCustomerSiteId": null,
            "ShipToCustomerSiteName": null,
            "InventoryItemId": 300100081232688,
            "ItemNumber": "AI-F-Bolt1",
            "ItemDescription": "AI-F-Bolt1\n",
            "UnitOfMeasure": "Each",
            "UOMCode": "Ea",
            "ForecastTotalForecastHorizonQuantity": 0,
            "ForecastTotalCommitHorizonQuantity": 0,
            "CommitTotalQuantity": null,
            "PublishedDate": "2017-08-23T04:07:50+00:00",
            "PublishedByPersonId": 300100036658848,
            "PublishedByUserName": "SCMOPERATIONS",
            "CommitDate": null,
            "CommitDueDate": "2017-08-26T04:07:51+00:00",
            "CollaborationCycleVersion": 2,
            "CreatedByPersonId": 300100036658848,
            "CreatedBy": "SCMOPERATIONS",
            "CreationDate": "2017-08-28T00:00:07+00:00",
            "LastUpdatedBy": "anonymous",
            "LastUpdateDate": "2018-06-05T23:44:49+00:00",
            "links": [
                {
                    ...
    }
                },
                {
                    ...
                },
                {
                    ...
                },
                {
                    ...
                },
                {
                    ...
                }
            ]
        },
        {
            "CollaborationOrderForecastEntryId": 4056,
            "CollaborationOrderForecastId": 152,
            "CorrelationCode": "300100122481598",
            "SupplyPlanName": null,
            "CollaborationSourceId": 3011,
            "CollaborationPlanId": 300100120934763,
            "PlanningCycleStartDate": "2017-08-21",
            "PlanningCycleEndDate": "2017-08-27",
            "ShipFromSupplierId": 230,
            "ShipFromSupplierName": "CV_SuppA00",
            "ShipFromSupplierNumber": "5001",
            "ShipFromSupplierDUNS": "987654321",
            "ShipFromSupplierAlternateName": null,
            "ShipFromSupplierSiteId": 5232,
            "ShipFromSupplierSiteName": "CVSuppA00Site01",
            "ProcurementBUId": 204,
            "ProcurementBUName": "Vision Corporation",
            "ShipToOrganizationId": 207,
            "ShipToOrganizationCode": "M1",
            "ShipToOrganizationName": "Manufacturing 1",
            "ShipToSupplierSiteId": null,
            "ShipToSupplierSiteName": null,
            "ShipToCustomerId": null,
            "ShipToCustomerName": null,
            "ShipToCustomerSiteId": null,
            "ShipToCustomerSiteName": null,
            "InventoryItemId": 300100081232688,
            "ItemNumber": "AI-F-Bolt1",
            "ItemDescription": "AI-F-Bolt1\n",
            "UOMCode": "Ea",
            "ForecastTotalForecastHorizonQuantity": 0,
            "ForecastTotalCommitHorizonQuantity": 0,
            "CommitTotalQuantity": null,
            "PublishedDate": "2017-08-23T04:07:45+00:00",
            "PublishedByPersonId": 300100036658848,
            "PublishedByUserName": "SCMOPERATIONS",
            "CommitDate": null,
            "CommitDueDate": "2017-08-26T04:07:46+00:00",
            "CollaborationCycleVersion": 2,
            "CreatedByPersonId": 300100036658848,
            "CreatedBy": "SCMOPERATIONS",
            "CreationDate": "2017-08-28T00:00:10+00:00",
            "LastUpdatedBy": "anonymous",
            "LastUpdateDate": "2018-06-05T23:44:49+00:00",
            "links": [
                {
                    ...
    }
                },
                {
                    ...
                },
                {
                    ...
                },
                {
                    ...
                },
                {
                    ...
                }
            ]
        }
    ]
}

Back to Top