Get all customer demand requests

get

/fscmRestApi/resources/11.13.18.05/collaborationCustomerDemandRequests

Get all customer demand requests

Request

Query Parameters
  • 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).
  • 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
  • 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
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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
  • 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
  • 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.

There's no request body for this operation.

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 : collaborationCustomerDemandRequests
Match All
Show Source
Nested Schema : CollectionProperties
Type: object
Show Source
Nested Schema : collaborationCustomerDemandRequests-allOf[1]
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborationCustomerDemandRequests-item-response
Match All
Show Source
Nested Schema : ItemProperties
Type: object
Show Source
Nested Schema : collaborationCustomerDemandRequests-item
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the customer demand request.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the customer demand request.
  • Title: Customer Demand Request ID
    Read Only: true
    Value that uniquely identifies the customer demand request.
  • Title: Customer Number
    Maximum Length: 30
    Number of the customer that receives the item.
  • Title: Customer Site Number
    Maximum Length: 30
    Number of the customer site that receives the item.
  • Title: Document Type Code
    Maximum Length: 30
    Abbreviation that identifies the type of document used for collaboration.
  • Title: Document Type Name
    Read Only: true
    Maximum Length: 300
    Type of document used for collaboration.
  • Title: Incremental Flag
    Contains 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.
  • Title: Item Level Value
    Maximum Length: 300
    Value that identifies the item level of the customer demand request.
  • Title: Last Update Date
    Read Only: true
    Date and time when the user most recently updated the customer demand request.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Login of the user who most recently updated the customer demand request.
  • Title: Measure Type Code
    Maximum Length: 18
    Abbreviation that identifies the type of measure used for collaboration within a document.
  • Title: Measure Type Name
    Read Only: true
    Maximum Length: 30
    Type of measure used for collaboration within a document.
  • Title: Item Level Value
    Maximum Length: 49
    Value that identifies the organization level of the customer demand request.
  • Title: Published By Party Code
    Read Only: true
    Abbreviation that identifies the party type that published the data.
  • Title: Published Date
    Read Only: true
    Date the user submitted the customer demand request.
  • Title: Status
    Read Only: true
    Current state of the customer demand request.
  • Title: Status Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the current state of the customer demand request.
Nested Schema : collaborationCustomerDemandRequests-item-response-allOf[2]
Type: object
Show Source
Nested Schema : details
Type: array
Show Source
Nested Schema : requestStatusDetails
Type: array
Show Source
Nested Schema : collaborationCustomerDemandRequests-details-item-response
Match All
Show Source
Nested Schema : collaborationCustomerDemandRequests-details-item
Type: object
Show Source
Nested Schema : collaborationCustomerDemandRequests-requestStatusDetails-item-response
Match All
Show Source
Nested Schema : collaborationCustomerDemandRequests-requestStatusDetails-item
Type: object
Show Source
Back to Top