Upload a file

post

/fscmRestApi/resources/11.13.18.05/collaborationCustomerDemandUploads

Request

Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Value that identifies the base 64 encoded customer demand file.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the request originated from a business-to-business message. If false, then it didn't. The default value is false.
  • Maximum Length: 64
    User who created the B2B message.
  • Value that uniquely identifies the uploaded customer demand file.
  • Maximum Length: 60
    Abbreviation that identifies the type of document used for collaboration.
  • Maximum Length: 255
    Type of document used for collaboration.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then errors occurred when processing the import data request. If false, then errors didn't occur. This attribute doesn't have a default value.
  • Maximum Length: 512
    Name of the uploaded customer demand file.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the data is processed as an incremental change within the editable date range. If false, then the data is processed as a full replace within the editable date range. The default value is false.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the data will be processed. If false, then the data won't be processed. The default value is false.
  • Maximum Length: 256
    Value that uniquely identifies the B2B message.
  • Maximum Length: 512
    Notes associated with the upload request.
  • Value that uniquely identifies the trading partner invoking the B2B message.
  • Status Details
    Title: Status Details
    The Status Details resource gets the errors associated with a customer demand upload request.
Nested Schema : Status Details
Type: array
Title: Status Details
The Status Details resource gets the errors associated with a customer demand upload request.
Show Source
Nested Schema : collaborationCustomerDemandUploads-statusDetails-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : collaborationCustomerDemandUploads-item-response
Type: object
Show Source
  • Value that identifies the base 64 encoded customer demand file.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the request originated from a business-to-business message. If false, then it didn't. The default value is false.
  • Maximum Length: 64
    User who created the B2B message.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Value that uniquely identifies the uploaded customer demand file.
  • Maximum Length: 60
    Abbreviation that identifies the type of document used for collaboration.
  • Maximum Length: 255
    Type of document used for collaboration.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then errors occurred when processing the import data request. If false, then errors didn't occur. This attribute doesn't have a default value.
  • Maximum Length: 512
    Name of the uploaded customer demand file.
  • Read Only: true
    Value that uniquely identifies the user's request to import data.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the data is processed as an incremental change within the editable date range. If false, then the data is processed as a full replace within the editable date range. The default value is false.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the data will be processed. If false, then the data won't be processed. The default value is false.
  • Read Only: true
    User who most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    Date and time when the user most recently updated the record.
  • Links
  • Read Only: true
    Value that uniquely identities the running Load Collaboration Customer Demand scheduled process.
  • Maximum Length: 256
    Value that uniquely identifies the B2B message.
  • Maximum Length: 512
    Notes associated with the upload request.
  • Value that uniquely identifies the trading partner invoking the B2B message.
  • Read Only: true
    Value that uniquely identifies the running Process Collaboration Customer Demand scheduled process.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Type of user who performed the requested action.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of user who performed the requested action. Values include ORA_VCS_INTEGRATION_SPECIALIST, ORA_VCS_CUSTOMER, ORA_VCS_ENTERPRISE.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Current state of the upload request.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the current state of the import data upload request.
  • Status Details
    Title: Status Details
    The Status Details resource gets the errors associated with a customer demand upload request.
Nested Schema : Status Details
Type: array
Title: Status Details
The Status Details resource gets the errors associated with a customer demand upload request.
Show Source
Nested Schema : collaborationCustomerDemandUploads-statusDetails-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to upload compressed files containing customer demands that are processed by Oracle Supply Chain Collaboration Cloud.

Step 1: Create a customer demand file

  • Create a CSV file with the these column headers: Customer Number, Customer Site, Item, Organization, Measure Code, Quantity, Date.
  • Compress the CSV file to ZIP format.
  • Encode the ZIP file to Base64 format.

Step 2: Create an upload request

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.action+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads"

Example Request Body

The following example includes the contents of the request body in JSON format. In this example, a file attahment is uploaded to the purchase order header successfully. 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.
{
    "DocumentTypeCode":"VCS_FORECAST",
    "IncrementalFlag":false,
    "Attachment":"UEsDBBQAA...",
    "Notes":"Order Forecast for the next 2 years."
}

Example Response Body

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

{
    "ImportRequestId": 300100549961841,
    "LoadProcessId": null,
    "ProcessId": null,
    "DocumentTypeCode": "VCS_FORECAST",
    "DocumentTypeName": "Forecast",
    "Filename": "CustomerDemand_11-19-2021-21-54-37.zip",
    "DocumentId": 292098,
    "StatusCode": "IN_PROCESS",
    "Status": null,
    "PublishedByPartyCode": "ORA_VCS_ENTERPRISE",
    "PublishedByParty": null,
    "Notes": "Order Forecast for the next 2 years.",
    "CreatedBy": "COLLABPLANNER",
    "CreationDate": "2021-11-19T21:54:37+00:00",
    "LastUpdatedBy": "COLLABPLANNER",
    "LastUpdateDate": "2021-11-19T21:54:38.970+00:00",
    "ErrorFlag": false,
    "IncrementalFlag": false,
    "InitiateProcessingFlag": false,
    "MessageId": null,
    "B2BUser": null,
    "B2BFlag": false,
    "PartnerId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads/300100549961841",
            "name": "collaborationCustomerDemandUploads",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads/300100549961841",
            "name": "collaborationCustomerDemandUploads",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads/300100549961841/child/statusDetails",
            "name": "statusDetails",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads/300100549961841/enclosure/Attachment",
            "name": "Attachment",
            "kind": "other"
        }
    ]
}
Back to Top