1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Cost Lists

Get all cost lists

get

/fscmRestApi/resources/11.13.18.05/costLists

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 Finds cost lists according to the primary key.
      Finder Variables
      • CostListId; integer; Identifier of the cost list based on which record is retrieved.
  • 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

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BusinessUnit; string; Name of the business unit.
    • BusinessUnitId; integer; Value that uniquely identifies the business unit.
    • ChargeDefinition; string; Name of the pricing charge definition.
    • ChargeDefinitionCode; string; Abbreviation that identifies the pricing charge definition of the cost list.
    • ChargeDefinitionId; integer; Value that uniquely identifies the pricing charge definition.
    • CostElement; string; Name of the cost element.
    • CostElementCode; string; Abbreviation that identifies the cost element for the cost list.
    • CostListDescription; string; Description of the cost list.
    • CostListId; integer; Value that uniquely identifies the cost list.
    • CostListName; string; Name of the cost list.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the record was created.
    • Currency; string; Currency of the cost list.
    • CurrencyCode; string; Abbreviation that identifies the currency of the cost list.
    • EndDate; string; Date when the record becomes inactive.
    • LastUpdateDate; string; Date and time when the application most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • StartDate; string; Date when the record becomes effective..
    • Status; string; Status of the cost list.
    • StatusCode; string; Abbreviation for the status of the cost list.
  • 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 : costLists
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : costLists-item-response
Type: object
Show Source
Nested Schema : Access Sets
Type: array
Title: Access Sets
An association of access sets for a cost list.
Show Source
Nested Schema : headerDFF
Type: array
Show Source
Nested Schema : Items
Type: array
Title: Items
An item and its associated cost charges.
Show Source
Nested Schema : costLists-accessSets-item-response
Type: object
Show Source
Nested Schema : costLists-headerDFF-item-response
Type: object
Show Source
Nested Schema : costLists-items-item-response
Type: object
Show Source
Nested Schema : Charges
Type: array
Title: Charges
A collection of charges for cost lists.
Show Source
Nested Schema : itemsDFF
Type: array
Show Source
Nested Schema : costLists-items-charges-item-response
Type: object
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : costLists-items-charges-chargesDFF-item-response
Type: object
Show Source
Nested Schema : costLists-items-itemsDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all cost lists.

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/costLists"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
  "items" : [ {
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "OrganizationName" : "Seattle Manufacturing",
    "WorkAreaId" : 300100071642891,
    "WorkAreaName" : "HCOP_WA",
    "WorkAreaDescription" : "HCOP_WA",
    "WorkAreaCode" : "HCOP_WA",
    "InactiveDate" : null
  }, {
...
  } ],
...
}
Back to Top