Get all upload requests
get
/fscmRestApi/resources/11.13.18.05/collaborationSupplyDataUploads
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:- 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.
- BOInErrorList; string; Comma-separated list of objects that weren't loaded to the staging tables.
- BOInWarningList; string; Comma-separated list of objects that encountered a warning when loaded to the staging tables.
- BOLoadErrorsFlag; boolean; Contains one of the following values: true or false. If true, then errors occurred when loading an object to the staging tables. If false, then errors didn't occur. The default value is false.
- BOLoadWarningsFlag; boolean; Contains one of the following values: true or false. If true, then warnings occurred when loading an object to the staging tables. If false, then warnings didn't occur. The default value is false.
- CollectionProcessId; integer; Value that uniquely identifies the running Collection Job Set scheduled process.
- CollectionType; string; Type of planning data collection process that can be launched.
- CollectionTypeCode; string; Abbreviation that identifies the type of planning data collection process that can be launched. Accepted values are 1 for Targeted and 2 for Net Change.
- CreatedBy; string; User who created the supply data request.
- CreationDate; string; Date and time when the user created the supply data request.
- DocumentId; integer; Value that uniquely identifies the uploaded supply data file.
- Filename; string; Name of the uploaded supply data file.
- ImportRequestId; integer; Value that uniquely identifies the user's request to import data.
- LastUpdateDate; string; Date and time when the user most recently updated the supply data request.
- LastUpdatedBy; string; User who most recently updated the supply data request.
- MessageId; string; Value that uniquely identifies the B2B message.
- Notes; string; Notes associated with the import request.
- ProcessErrorsFlag; boolean; Contains one of the following values: true or false. If true, then errors occurred when processing the supply data request. If false, then errors didn't occur. The default value is false.
- ProcessId; integer; Value that uniquely identifies the running Load Supply Data for Externally Managed Organizations scheduled process.
- RefreshNumber; integer; Number used by the Collection Job Set scheduled process to collect data.
- RequestSource; string; Type of user who performed the request action. Values include Enterprise or Supplier.
- RequestSourceCode; string; Abbreviation that identifies the type of user who performed the request action.
- SourceSystem; string; Alphanumeric code used to identify the source application.
- Status; string; Current state of the import request.
- StatusCode; string; Abbreviation that identifies the current state of the import request.
- SupplierId; integer; Value that uniquely identifies the trading partner invoking the B2B message
-
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 : collaborationSupplyDataUploads
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 : collaborationSupplyDataUploads-item-response
Type:
Show Source
object
-
Attachment: string
(byte)
Value that identifies the base64-encoded supply data 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
Maximum Length:
64
User who created the B2B message. -
BOInErrorList: string
Read Only:
true
Maximum Length:404
Comma-separated list of objects that weren't loaded to the staging tables. -
BOInWarningList: string
Read Only:
true
Maximum Length:404
Comma-separated list of objects that encountered a warning when loaded to the staging tables. -
BOLoadErrorsFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then errors occurred when loading an object to the staging tables. If false, then errors didn't occur. The default value is false. -
BOLoadWarningsFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then warnings occurred when loading an object to the staging tables. If false, then warnings didn't occur. The default value is false. -
CollectionProcessId: integer
(int64)
Read Only:
true
Value that uniquely identifies the running Collection Job Set scheduled process. -
CollectionType: string
Type of planning data collection process that can be launched.
-
CollectionTypeCode: string
Maximum Length:
32
Abbreviation that identifies the type of planning data collection process that can be launched. Accepted values are 1 for Targeted and 2 for Net Change. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the supply data request. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the supply data request. -
DocumentId: integer
(int64)
Value that uniquely identifies the uploaded supply data file.
-
Filename: string
Maximum Length:
512
Name of the uploaded supply data file. -
ImportRequestId: integer
(int64)
Read Only:
true
Value that uniquely identifies the user's request to import data. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the supply data request. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the supply data request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageId: string
Maximum Length:
256
Value that uniquely identifies the B2B message. -
Notes: string
Maximum Length:
500
Notes associated with the import request. -
ProcessErrorsFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then errors occurred when processing the supply data request. If false, then errors didn't occur. The default value is false. -
ProcessId: integer
(int64)
Read Only:
true
Value that uniquely identifies the running Load Supply Data for Externally Managed Organizations scheduled process. -
RefreshNumber: integer
(int64)
Read Only:
true
Number used by the Collection Job Set scheduled process to collect data. -
RequestSource: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of user who performed the request action. Values include Enterprise or Supplier. -
RequestSourceCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of user who performed the request action. -
SourceSystem: string
Maximum Length:
30
Alphanumeric code used to identify the source application. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Current state of the import request. -
StatusCode: string
Read Only:
true
Maximum Length:32
Abbreviation that identifies the current state of the import request. -
statusDetails: array
Status Details
Title:
Status Details
The Status Details resource gets the errors associated with a supply data upload request. -
SupplierId: integer
(int64)
Value that uniquely identifies the trading partner invoking the B2B message
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 supply data 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 : collaborationSupplyDataUploads-statusDetails-item-response
Type:
Show Source
object
-
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Read Only:
true
Maximum Length:2000
Text of the message related to the import request. -
MessageType: string
Read Only:
true
Maximum Length:150
Type of message in the import request. Values include ERROR_SEC and ERROR_REC. ERROR_SEC: For errors that occur when running the Load Supply Data for Externally Managed Organizations scheduled process. ERROR_REC: For errors that occur when running the Collection Job Set scheduled process. -
ObjectType: string
Read Only:
true
Maximum Length:80
Type of object in the import request. -
ObjectTypeCode: string
Read Only:
true
Maximum Length:29
Abbreviation that identifies the type of object in the import request. -
OrderType: string
Read Only:
true
Maximum Length:320
Type of order for the object in the import request. -
OrderTypeCode: integer
Read Only:
true
Abbreviation that identifies the type of order for the object in the import request. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization that receives the item. -
SupplierName: string
Read Only:
true
Maximum Length:360
Name of the supplier who ships the item. -
SupplierSiteName: string
Read Only:
true
Maximum Length:30
Name of the supplier site that ships the item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source