Get all upload requests
get
/fscmRestApi/resources/11.13.18.05/collaborationCustomerDemandUploads
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 upload requests according to the request identifier.
Finder Variables- ImportRequestId; integer; Value that uniquely identifies the user's request to import data.
- PrimaryKey Find upload requests according to the request identifier.
-
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:- Attachment; string; Value that identifies the base 64 encoded customer demand file.
- B2BFlag; boolean; 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.
- B2BUser; string; User who created the B2B message.
- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- DocumentId; integer; Value that uniquely identifies the uploaded customer demand file.
- DocumentTypeCode; string; Abbreviation that identifies the type of document used for collaboration.
- DocumentTypeName; string; Type of document used for collaboration.
- ErrorFlag; boolean; 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.
- Filename; string; Name of the uploaded customer demand file.
- ImportRequestId; integer; Value that uniquely identifies the user's request to import data.
- IncrementalFlag; boolean; 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.
- InitiateProcessingFlag; boolean; 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.
- LastUpdateDate; string; User who most recently updated the record.
- LastUpdatedBy; string; Date and time when the user most recently updated the record.
- LoadProcessId; integer; Value that uniquely identities the running Load Collaboration Customer Demand scheduled process.
- MessageId; string; Value that uniquely identifies the B2B message.
- Notes; string; Notes associated with the upload request.
- PartnerId; integer; Value that uniquely identifies the trading partner invoking the B2B message.
- ProcessId; integer; Value that uniquely identifies the running Process Collaboration Customer Demand scheduled process.
- PublishedByParty; string; Type of user who performed the requested action.
- PublishedByPartyCode; string; Abbreviation that identifies the type of user who performed the requested action. Values include ORA_VCS_INTEGRATION_SPECIALIST, ORA_VCS_CUSTOMER, ORA_VCS_ENTERPRISE.
- Status; string; Current state of the upload request.
- StatusCode; string; Abbreviation that identifies the current state of the import data upload request.
-
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 TopResponse
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.
Root Schema : collaborationCustomerDemandUploads
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationCustomerDemandUploads-item-response
Type:
Show Source
object
-
Attachment: string
(byte)
Value that identifies the base 64 encoded customer demand file.
-
B2BFlag: boolean
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. -
B2BUser: string
Maximum Length:
64
User who created the B2B message. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DocumentId: integer
(int64)
Value that uniquely identifies the uploaded customer demand file.
-
DocumentTypeCode: string
Maximum Length:
60
Abbreviation that identifies the type of document used for collaboration. -
DocumentTypeName: string
Maximum Length:
255
Type of document used for collaboration. -
ErrorFlag: boolean
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. -
Filename: string
Maximum Length:
512
Name of the uploaded customer demand file. -
ImportRequestId: integer
(int64)
Read Only:
true
Value that uniquely identifies the user's request to import data. -
IncrementalFlag: boolean
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. -
InitiateProcessingFlag: boolean
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. -
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date and time when the user most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadProcessId: integer
(int64)
Read Only:
true
Value that uniquely identities the running Load Collaboration Customer Demand scheduled process. -
MessageId: string
Maximum Length:
256
Value that uniquely identifies the B2B message. -
Notes: string
Maximum Length:
512
Notes associated with the upload request. -
PartnerId: integer
(int64)
Value that uniquely identifies the trading partner invoking the B2B message.
-
ProcessId: integer
(int64)
Read Only:
true
Value that uniquely identifies the running Process Collaboration Customer Demand scheduled process. -
PublishedByParty: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of user who performed the requested action. -
PublishedByPartyCode: string
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. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Current state of the upload request. -
StatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the current state of the import data upload request. -
statusDetails: array
Status Details
Title:
Status Details
The Status Details resource gets the errors associated with a customer demand upload request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : collaborationCustomerDemandUploads-statusDetails-item-response
Type:
Show Source
object
-
ErrorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the error, if any, in the request. -
ImportRequestId: integer
(int64)
Read Only:
true
Value that uniquely identifies the import data source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the message related to the import request. -
MessageToken: string
Read Only:
true
Maximum Length:30
Value that identifies the first token of the message. -
MessageToken2: string
Read Only:
true
Maximum Length:30
Value that identifies the second token of the message. -
MessageToken3: string
Read Only:
true
Maximum Length:30
Value that identifies the third token of the message. -
MessageTokenValue: string
Read Only:
true
Maximum Length:300
Value of the first token of the message. -
MessageTokenValue2: string
Read Only:
true
Maximum Length:300
Value of the second token of the message. -
MessageTokenValue3: string
Read Only:
true
Maximum Length:300
Value of the third token of the message. -
RowNumber: integer
Read Only:
true
Number that identifies the row in the comma-separated values file if using file import.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- downloadTemplate
-
Operation: /fscmRestApi/resources/11.13.18.05/collaborationCustomerDemandUploads/action/downloadTemplateDownloads a customer demand template for the specified document.
Examples
This example describes how to get all upload requests.
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/collaborationCustomerDemandUploads"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads?q=ErrorFlag=true&expand=statusDetails&onlyData=true"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ImportRequestId": 300100548922196, "LoadProcessId": 87763, "ProcessId": 110090, "DocumentTypeCode": "VCS_CONSUMPTION", "DocumentTypeName": "Consumption", "Filename": "demandconsumption.zip", "DocumentId": 82622, "StatusCode": "PARTIAL_SUCCESS", "Status": "Partial success", "PublishedByPartyCode": "ORA_VCS_CUSTOMER", "PublishedByParty": "Customer", "Notes": "consumption", "CreatedBy": "demandcustomer", "CreationDate": "2021-09-01T09:38:43+00:00", "LastUpdatedBy": "COLLABPLANNER", "LastUpdateDate": "2021-09-07T06:10:47+00:00", "ErrorFlag": true, "IncrementalFlag": false, "InitiateProcessingFlag": false, "MessageId": null, "B2BUser": null, "B2BFlag": false, "PartnerId": null, "statusDetails": { "items": [ { "RowNumber": 2, "MessageCode": "VCS_NO_VALUE", "ImportRequestId": 300100548922196, "MessageToken": "ATTRIBUTE_NAME", "MessageTokenValue": "MeasureTypeCode", "MessageToken2": "ATTRIBUTE_VALUE", "MessageTokenValue2": "ORDER_FORECAST", "MessageToken3": null, "MessageTokenValue3": null, "ErrorId": 9009, "@context": { "key": "9009" } }, { "RowNumber": 3, "MessageCode": "VCS_NO_VALUE", "ImportRequestId": 300100548922196, "MessageToken": "ATTRIBUTE_NAME", "MessageTokenValue": "MeasureTypeCode", "MessageToken2": "ATTRIBUTE_VALUE", "MessageTokenValue2": "ORDER_FORECAST", "MessageToken3": null, "MessageTokenValue3": null, "ErrorId": 9010, "@context": { "key": "9010" } } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads/300100548922196/child/statusDetails", "name": "statusDetails", "kind": "collection" } ] }, "@context": { "key": "300100548922196", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } } }, { "ImportRequestId": 300100548911747, "LoadProcessId": 87326, "ProcessId": 110090, "DocumentTypeCode": "VCS_CONSUMPTION", "DocumentTypeName": "Consumption", "Filename": "demandforecast.zip", "DocumentId": 82185, "StatusCode": "FAILURE", "Status": "Failure", "PublishedByPartyCode": "ORA_VCS_ENTERPRISE", "PublishedByParty": "Enterprise", "Notes": null, "CreatedBy": "COLLABPLANNER", "CreationDate": "2021-09-01T07:21:58+00:00", "LastUpdatedBy": "COLLABPLANNER", "LastUpdateDate": "2021-09-07T06:10:47+00:00", "ErrorFlag": true, "IncrementalFlag": true, "InitiateProcessingFlag": false, "MessageId": null, "B2BUser": null, "B2BFlag": false, "PartnerId": null, "statusDetails": { "items": [ { "RowNumber": 2, "MessageCode": "VCS_NO_VALUE", "ImportRequestId": 300100548911747, "MessageToken": "ATTRIBUTE_NAME", "MessageTokenValue": "MeasureTypeCode", "MessageToken2": "ATTRIBUTE_VALUE", "MessageTokenValue2": "ORDER_FORECAST", "MessageToken3": null, "MessageTokenValue3": null, "ErrorId": 9007, "@context": { "key": "9007" } }, { "RowNumber": 3, "MessageCode": "VCS_NO_VALUE", "ImportRequestId": 300100548911747, "MessageToken": "ATTRIBUTE_NAME", "MessageTokenValue": "MeasureTypeCode", "MessageToken2": "ATTRIBUTE_VALUE", "MessageTokenValue2": "ORDER_FORECAST", "MessageToken3": null, "MessageTokenValue3": null, "ErrorId": 9008, "@context": { "key": "9008" } } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads/300100548911747/child/statusDetails", "name": "statusDetails", "kind": "collection" } ] }, "@context": { "key": "300100548911747", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } } } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads", "name": "collaborationCustomerDemandUploads", "kind": "collection" } ] }