Get all customer demand requests
get
/fscmRestApi/resources/11.13.18.05/collaborationCustomerDemandRequests
Get all customer demand requests
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
Finder Variables:- CustomerDemandRequestId
- PrimaryKey
-
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 -
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
- application/vnd.oracle.adf.resourcecollection+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.
Nested Schema : CollectionProperties
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.
-
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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 : collaborationCustomerDemandRequests-allOf[1]
Type:
Show Source
object-
items: array
Items
Title:
ItemsThe items in the collection.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : ItemProperties
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : collaborationCustomerDemandRequests-item
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the customer demand request. -
CreationDate: string
(date)
Title:
Creation DateRead Only:trueDate and time when the user created the customer demand request. -
CustomerDemandRequestId: integer
Title:
Customer Demand Request IDRead Only:trueValue that uniquely identifies the customer demand request. -
CustomerNumber: string
Title:
Customer NumberMaximum Length:30Number of the customer that receives the item. -
CustomerSiteNumber: string
Title:
Customer Site NumberMaximum Length:30Number of the customer site that receives the item. -
DocumentTypeCode: string
Title:
Document Type CodeMaximum Length:30Abbreviation that identifies the type of document used for collaboration. -
DocumentTypeName: string
Title:
Document Type NameRead Only:trueMaximum Length:300Type of document used for collaboration. -
IncrementalFlag: boolean
Title:
Incremental FlagContains one of the following values: true or false. If true, then only the quantities for the dates provided will be updated. If false, then quantities for all dates will be updated. -
ItemLevelValue: string
Title:
Item Level ValueMaximum Length:300Value that identifies the item level of the customer demand request. -
LastUpdateDate: string
(date)
Title:
Last Update DateRead Only:trueDate and time when the user most recently updated the customer demand request. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Login of the user who most recently updated the customer demand request. -
MeasureTypeCode: string
Title:
Measure Type CodeMaximum Length:18Abbreviation that identifies the type of measure used for collaboration within a document. -
MeasureTypeName: string
Title:
Measure Type NameRead Only:trueMaximum Length:30Type of measure used for collaboration within a document. -
OrganizationLevelValue: string
Title:
Item Level ValueMaximum Length:49Value that identifies the organization level of the customer demand request. -
PublishedByPartyCode: string
Title:
Published By Party CodeRead Only:trueAbbreviation that identifies the party type that published the data. -
PublishedDate: string
Title:
Published DateRead Only:trueDate the user submitted the customer demand request. -
Status: string
Title:
StatusRead Only:trueCurrent state of the customer demand request. -
StatusCode: string
Title:
Status CodeRead Only:trueMaximum Length:30Abbreviation that identifies the current state of the customer demand request.
- canonical
-
Method: getPath:
fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id} - details
-
Method: getPath:
/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details - requestStatusDetails
-
Method: getPath:
/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/requestStatusDetails - self
-
Method: getPath:
fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : collaborationCustomerDemandRequests-details-item
Type:
Show Source
object-
Date: string
(date)
Title:
DateDate on the measure. -
DetailsId: number
Title:
Details IDRead Only:trueValue that uniquely identifies the detail for the customer demand request. -
Quantity: number
Title:
QuantityQuantity for a specified date on the measure.
- canonical
-
Method: getPath:
/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id} - parent
-
Method: getPath:
/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id} - self
-
Method: getPath:
/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}
Nested Schema : collaborationCustomerDemandRequests-requestStatusDetails-item-response
Match All
Show Source
Nested Schema : collaborationCustomerDemandRequests-requestStatusDetails-item
Type:
Show Source
object-
CustomerDemandRequestId: integer
Title:
Customer Demand Request IDRead Only:trueValue that identifies the customer demand request. -
DetailsId: integer
Title:
Details IDRead Only:trueValue that identifies the detail of the customer demand request. -
MessageCode: string
Title:
Message CodeRead Only:trueValue that identifies the message associated with the customer demand request or detail record. -
MessageToken: string
Title:
Message TokenRead Only:trueFirst token of the message code. -
MessageToken2: string
Title:
Message Token 2Read Only:trueSecond token of the message code. -
MessageToken3: string
Title:
Message Token 3Read Only:trueThird token of the message code. -
MessageTokenValue: string
Title:
Message Token ValueRead Only:trueFirst token value of the message code. -
MessageTokenValue2: string
Title:
Message Token Value 2Read Only:trueSecond token value of the message code. -
MessageTokenValue3: string
Title:
Message Token Value 3Read Only:trueThird token value of the message code. -
MessageType: string
Title:
Message TypeRead Only:trueType of message associated with the customer demand request or detail record. -
MessageTypeCode: string
Title:
Message Type CodeRead Only:trueValue that identifies the type of message associated with the customer demand request or detail record. -
RequestStatusDetailsId: integer
Title:
Request Status Details IDRead Only:trueValue that uniquely identifies the request status detail associated with the message code.
- canonical
-
Method: getPath:
/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/requestStatusDetails/{collaborationCustomerDemandRequests_requestStatusDetails_Id} - parent
-
Method: getPath:
/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id} - self
-
Method: getPath:
/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/requestStatusDetails/{collaborationCustomerDemandRequests_requestStatusDetails_Id}