Jump to

• Request
• Response
• Examples

Create forecasts

post

/fscmRestApi/resources/11.13.18.05/collaborationOrderForecastRequests

Request

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CollaborationOrderForecastRequestId: integer (int64)
  Value that uniquely identifies the request for the collaboration order forecast.
• details: array Details
  Title: Details

  The Details resource manages details about collaboration order forecasts that you request.
• ItemNumber(required): string
  Maximum Length: 300

  Number that identifies the item.
• 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.
• ProcurementBUName: string
  Maximum Length: 240

  Name of the business unit. The application assigns the supplier to this business unit.
• requestStatusDetails: array Statuses
  Title: Statuses

  The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.
• ShipFromSupplierName(required): string
  Maximum Length: 360

  Name of the supplier that ships the item.
• ShipFromSupplierSiteName(required): string
  Maximum Length: 240

  Name of the supplier site that ships the item.
• ShipToCustomerName: string
  Maximum Length: 360

  Name of the customer that receives the item.
• ShipToCustomerSiteName: string
  Maximum Length: 240

  Name of the customer site that received the item.
• ShipToCustomerSiteNumber: string
  Maximum Length: 30

  Number that identifies the customer site that received the item.
• ShipToOrganizationCode(required): string
  Maximum Length: 49

  Name of the organization that receives the item.
• SupplyPlanDescription(required): string
  Maximum Length: 100

  Description of the supply plan that was used to generate the collaboration order forecast.
• SupplyPlanName(required): string
  Maximum Length: 30

  Name of the supply plan that was used to generate the collaboration order forecast.
• UnitOfMeasure: string
  Maximum Length: 25

  Unit of measure for the item.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the item.

{
    "required":[
        "ItemNumber",
        "ShipFromSupplierName",
        "ShipFromSupplierSiteName",
        "ShipToOrganizationCode",
        "SupplyPlanDescription",
        "SupplyPlanName"
    ],
    "type":"object",
    "properties":{
        "NoteToSupplier":{
            "maxLength":1000,
            "type":"string",
            "description":"Note provided by the collaboration planner to the supplier.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the item.",
            "nullable":true
        },
        "CollaborationOrderForecastRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request for the collaboration order forecast.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplyPlanDescription":{
            "maxLength":100,
            "type":"string",
            "description":"Description of the supply plan that was used to generate the collaboration order forecast.",
            "nullable":false
        },
        "NoteToPlanner":{
            "maxLength":1000,
            "type":"string",
            "description":"Note provided by the supplier to the collaboration planner.",
            "nullable":true
        },
        "ShipToCustomerName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer that receives the item.",
            "nullable":true
        },
        "ShipToCustomerSiteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the customer site that received the item.",
            "nullable":true
        },
        "ShipToCustomerSiteName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer site that received the item.",
            "nullable":true
        },
        "ShipFromSupplierSiteName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":false
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":false
        },
        "requestStatusDetails":{
            "title":"Statuses",
            "type":"array",
            "description":"The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecastRequests-requestStatusDetails-item-post-request"
            }
        },
        "ProcurementBUName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier to this business unit.",
            "nullable":true
        },
        "ShipFromSupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier that ships the item.",
            "nullable":false
        },
        "details":{
            "title":"Details",
            "type":"array",
            "description":"The Details resource manages details about collaboration order forecasts that you request.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecastRequests-details-item-post-request"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item.",
            "nullable":true
        },
        "SupplyPlanName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the supply plan that was used to generate the collaboration order forecast.",
            "nullable":false
        },
        "ShipToOrganizationCode":{
            "maxLength":49,
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":false
        }
    }
}

Nested Schema : Details

Type: array

Title: Details

The Details resource manages details about collaboration order forecasts that you request.

Show Source

• Array of: object schema

{
    "title":"Details",
    "type":"array",
    "description":"The Details resource manages details about collaboration order forecasts that you request.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecastRequests-details-item-post-request"
    }
}

Nested Schema : Statuses

Type: array

Title: Statuses

The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.

Show Source

• Array of: object collaborationOrderForecastRequests-requestStatusDetails-item-post-request

{
    "title":"Statuses",
    "type":"array",
    "description":"The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecastRequests-requestStatusDetails-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• BucketStartDate: string (date)
  Date when the time bucket starts.
• CollaborationOrderForecastRequestId: string
  Maximum Length: 18

  Value that uniquely identifies the request for the collaboration order forecast.
• 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.
• Quantity: number
  Quantity of the publisher order type.
• 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.
• ReferenceHeaderNumber: string
  Maximum Length: 64

  Reference header number 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.
• ReferenceLineLocationNumber: string
  Maximum Length: 64

  Number that 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.
• ReferenceLineNumber: string
  Maximum Length: 64

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

{
    "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
        },
        "ReferenceHeaderNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Reference header number 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.",
            "nullable":true,
            "x-queryable":false
        },
        "CollaborationOrderForecastRequestId":{
            "maxLength":18,
            "type":"string",
            "description":"Value that uniquely identifies the request for the collaboration order forecast.",
            "nullable":true
        },
        "ReferenceLineNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Number that 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.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the publisher order type.",
            "nullable":false
        },
        "ReferenceLineLocationNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Number that 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.",
            "nullable":true,
            "x-queryable":false
        },
        "BucketStartDate":{
            "type":"string",
            "description":"Date when the time bucket starts.",
            "format":"date",
            "nullable":false
        },
        "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-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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-queryable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : collaborationOrderForecastRequests-requestStatusDetails-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : collaborationOrderForecastRequests-item-response

Type: object

Show Source

• CollaborationOrderForecastRequestId: integer (int64)
  Value that uniquely identifies the request for the collaboration order forecast.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the collaboration order forecast.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the collaboration order forecast.
• details: array Details
  Title: Details

  The Details resource manages details about collaboration order forecasts that you request.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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.
• ProcessId: integer (int64)
  Read Only: true

  Value that uniquely identifies the scheduled process that was used to decompose the request.
• ProcurementBUName: string
  Maximum Length: 240

  Name of the business unit. The application assigns the supplier to this business unit.
• requestStatusDetails: array Statuses
  Title: Statuses

  The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.
• ShipFromSupplierName: string
  Maximum Length: 360

  Name of the supplier that ships the item.
• ShipFromSupplierSiteName: string
  Maximum Length: 240

  Name of the supplier site that ships the item.
• ShipToCustomerName: string
  Maximum Length: 360

  Name of the customer that receives the item.
• ShipToCustomerSiteName: string
  Maximum Length: 240

  Name of the customer site that received the item.
• ShipToCustomerSiteNumber: string
  Maximum Length: 30

  Number that identifies the customer site that received the item.
• ShipToOrganizationCode: string
  Maximum Length: 49

  Name of the organization that receives the item.
• SourceSystem: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
• SourceSystemCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_VCS_SRCSYSTEM_ORACLE

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

  Maximum Length: 30

  Abbreviation that identifies the current state of the collaboration order forecast. Values included ERROR, SUBMITTED, PROCESSING, PUBLISHED, and PUBLISHED_B2B_ONLY.
• SupplyPlanDescription: string
  Maximum Length: 100

  Description of the supply plan that was used to generate the collaboration order forecast.
• SupplyPlanName: string
  Maximum Length: 30

  Name of the supply plan that was used to generate the collaboration order forecast.
• UnitOfMeasure: string
  Maximum Length: 25

  Unit of measure for the item.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the item.

{
    "type":"object",
    "properties":{
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the collaboration order forecast.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request for the collaboration order forecast.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplyPlanDescription":{
            "maxLength":100,
            "type":"string",
            "description":"Description of the supply plan that was used to generate the collaboration order forecast.",
            "nullable":false,
            "x-queryable":true
        },
        "NoteToPlanner":{
            "maxLength":1000,
            "type":"string",
            "description":"Note provided by the supplier to the collaboration planner.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToCustomerName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer that receives the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToCustomerSiteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the customer site that received the item.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the current state of the collaboration order forecast. Values included ERROR, SUBMITTED, PROCESSING, PUBLISHED, and PUBLISHED_B2B_ONLY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToCustomerSiteName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer site that received the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierSiteName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":false,
            "x-queryable":true
        },
        "requestStatusDetails":{
            "title":"Statuses",
            "type":"array",
            "description":"The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecastRequests-requestStatusDetails-item-response"
            }
        },
        "ProcurementBUName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier to this business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier that ships the item.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceSystemCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_VCS_SRCSYSTEM_ORACLE",
            "x-queryable":true
        },
        "details":{
            "title":"Details",
            "type":"array",
            "description":"The Details resource manages details about collaboration order forecasts that you request.",
            "items":{
                "$ref":"#/components/schemas/collaborationOrderForecastRequests-details-item-response"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process that was used to decompose the request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":255,
            "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":true,
            "readOnly":true,
            "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":30,
            "type":"string",
            "description":"Name of the supply plan that was used to generate the collaboration order forecast.",
            "nullable":false,
            "x-queryable":true
        },
        "ShipToOrganizationCode":{
            "maxLength":49,
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Details

Type: array

Title: Details

The Details resource manages details about collaboration order forecasts that you request.

Show Source

• Array of: object collaborationOrderForecastRequests-details-item-response

{
    "title":"Details",
    "type":"array",
    "description":"The Details resource manages details about collaboration order forecasts that you request.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecastRequests-details-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 : Statuses

Type: array

Title: Statuses

The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.

Show Source

• Array of: object collaborationOrderForecastRequests-requestStatusDetails-item-response

{
    "title":"Statuses",
    "type":"array",
    "description":"The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.",
    "items":{
        "$ref":"#/components/schemas/collaborationOrderForecastRequests-requestStatusDetails-item-response"
    }
}

Nested Schema : collaborationOrderForecastRequests-details-item-response

Type: object

Show Source

• BucketStartDate: string (date)
  Date when the time bucket starts.
• CollaborationOrderForecastRequestId: string
  Maximum Length: 18

  Value that uniquely identifies the request for the collaboration order forecast.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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.
• Quantity: number
  Quantity of the publisher order type.
• 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.
• ReferenceHeaderNumber: string
  Maximum Length: 64

  Reference header number 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.
• ReferenceLineLocationNumber: string
  Maximum Length: 64

  Number that 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.
• ReferenceLineNumber: string
  Maximum Length: 64

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

{
    "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
        },
        "ReferenceHeaderNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Reference header number 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.",
            "nullable":true,
            "x-queryable":false
        },
        "CollaborationOrderForecastRequestId":{
            "maxLength":18,
            "type":"string",
            "description":"Value that uniquely identifies the request for the collaboration order forecast.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceLineNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Number that 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.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the publisher order type.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceLineLocationNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Number that 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.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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-queryable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : collaborationOrderForecastRequests-requestStatusDetails-item-response

Type: object

Show Source

• CollaborationOrderForecastRequestId: integer (int64)
  Read Only: true

  Value that uniquely identifies the request for the collaboration order forecast.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestDetailId: integer
  Read Only: true

  Value that uniquely identifies the request detail for the collaboration order forecast.
• StatusDetailCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the request status for the collaboration order forecast. The application uses this attribute to provide error or status detail regarding the collaboration order forecast when the Supply Planning Collaboration Decomposition scheduled process runs.
• StatusDetailType: string
  Read Only: true

  Maximum Length: 30

  Value that identifies the type of status detail. Values include Error or Information.

{
    "type":"object",
    "properties":{
        "StatusDetailCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the request status for the collaboration order forecast. The application uses this attribute to provide error or status detail regarding the collaboration order forecast when the Supply Planning Collaboration Decomposition scheduled process runs.",
            "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"
            }
        },
        "RequestDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request detail for the collaboration order forecast.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDetailType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the type of status detail. Values include Error or Information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollaborationOrderForecastRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request for the collaboration order forecast.",
            "format":"int64",
            "nullable":false,
            "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"
    }
}

Links

details

Operation: /fscmRestApi/resources/11.13.18.05/collaborationOrderForecastRequests/{CollaborationOrderForecastRequestId}/child/details

Parameters:

• CollaborationOrderForecastRequestId: $request.path.CollaborationOrderForecastRequestId

The Details resource manages details about collaboration order forecasts that you request.

requestStatusDetails

Operation: /fscmRestApi/resources/11.13.18.05/collaborationOrderForecastRequests/{CollaborationOrderForecastRequestId}/child/requestStatusDetails

Parameters:

• CollaborationOrderForecastRequestId: $request.path.CollaborationOrderForecastRequestId

The Statuses resource manages details about collaboration order forecasts that you request, such as, Processing Type, Error Code, or Error Message.

Back to Top

Examples

This example describes how to create forecasts.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

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

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "SupplyPlanName": "US_Production",
    "SupplyPlanDescription":"US Production Plan",
    "ShipFromSupplierName" : "CV_SuppD01",
    "ShipToOrganizationCode": "M1",
    "ShipFromSupplierSiteName": "CV_SuppD01Site1", 
    "ItemNumber": "SCC-CNTRDL-03",
    "details": [
            {
            "Quantity": 99,
            "PublisherOrderTypeCode": "SUPPLY_FORECAST",
            "BucketStartDate": "2019-11-28"
            }
     ]
}

Example Response Body

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

{
    "CollaborationOrderForecastRequestId": 300100152655935,
    "StatusCode": "SUBMITTED",
    "SupplyPlanName": "US_Production",
    "SupplyPlanDescription": "US Production Plan",
    "ProcurementBUName": null,
    "ShipFromSupplierName": "CV_SuppD01",
    "ShipFromSupplierSiteName": "CV_SuppD01Site1",
    "ShipToOrganizationCode": "M1",
    "ShipToCustomerName": null,
    "ShipToCustomerSiteName": null,
    "ShipToCustomerSiteNumber": null,
    "ItemNumber": "SCC-CNTRDL-03",
    "CreatedBy": "COLLABPLANNER",
    "CreationDate": "2018-07-25T18:03:29+00:00",
    "details": {
        "items": [
            {
                "CollaborationOrderForecastRequestId": "300100152655935",
                "PublisherOrderTypeCode": "SUPPLY_FORECAST",
                "BucketStartDate": "2019-11-28",
                "Quantity": 99,
                "ReferenceHeaderId": null,
                "ReferenceLineId": null,
                "ReferenceLineLocationId": null,
                "ReferenceHeaderNumber": null,
                "ReferenceLineNumber": null,
                "ReferenceLineLocationNumber": null,
                "links": [
                    {
                        ...
                    },
                    {
                        ...
                    },
                    {
                        ...
                    }
                ]
            }
        ],
        "count": 1,
        "hasMore": false,
        "limit": 25,
        "offset": 0,
        "links": [
            {
    ...
   }
        ]
    },
    "links": [
        {
            ...
        },
        {
            ...
        },
        {
            ...
        },
        {
            ...
        }
    ]
}

Back to Top